Skip to content

Commit 31f8c03

Browse files
committed
Update README.md with usage and description.
1 parent d0d3fea commit 31f8c03

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Then install squashy using PyPi
1818
pip install squashy
1919
````
2020

21+
## Usage
22+
See the `demos` folder for a Jupyter notebook showing a quick start guide to using Squashy.
23+
A demo showing the individual component classes is coming soon.
24+
2125
## What does it do?
2226

2327
At some point the key tools of network analysis struggle with scale. Beyond a few hundred nodes, graphs become too dense
@@ -29,4 +33,13 @@ settings or actually _see_ your data.
2933
➡️Squashy⬅️can compress graphs made up of millions of nodes and edges into a graph of a few hundred nodes that retains the overall structure.
3034

3135
## How does it work?
32-
Demo and quick start code coming.
36+
Squashy is based on work by Natalie Stanley and colleagues published in _Scientific Reports_ ([DOI](http://dx.doi.org/10.1038/s41598-018-29174-3)).
37+
In short compression works by first identifying nodes in the network to be 'supernodes' or what we refer to in Squashy as 'CORE' nodes.
38+
These are determined by a process of K-Core decomposition, trimming away at the graph until all nodes have a degree of `k`, which is typically 2.
39+
Once this point is reached, the highest degree node is selected as a CORE, removed from the network and decomposition repeats until either there are no nodes left, or the desired number of CORES is reached.
40+
41+
After decomposition, nodes are assigned to CORE nodes to represent them, through a process of breadth-first-search. Finally, new edges are created between nodes that represent the underlying edges of the nodes they represent.
42+
These edges are weighted to best represent the relationship between the nodes represented by two different cores. A graph formed of these core nodes and representative edges is our core graph, and should represent the underlying structure of the full raw graph.
43+
44+
### Documentation?
45+
Please see the `demos` folder for a quickstart guide. Built-in documentation of the major classes and methods of Squashy is next on the list!

0 commit comments

Comments
 (0)