graph-force/README.md

39 lines
846 B
Markdown
Raw Normal View History

2022-11-20 16:14:34 +00:00
# Graph Force
2022-11-20 16:11:41 +00:00
A python/rust library for embedding graphs in 2D space, using force-directed layouts.
2022-11-20 18:03:45 +00:00
## Installation
2022-11-20 16:14:34 +00:00
2022-11-20 18:03:45 +00:00
```bash
pip install graph_force
2022-11-20 16:14:34 +00:00
```
## Usage
```python
import graph_force
edges = [(0, 1), (1, 2), (2, 3), (3, 0)]
pos = graph_force.layout_from_edge_list(4, edges)
2022-11-20 18:01:52 +00:00
```
### Example with networkx
```python
import networkx as nx
import graph_force
G = nx.grid_2d_graph(10, 10)
# we have to map the names to integers
# as graph_force only supports integers as node ids at the moment
edges = []
mapping = {n: i for i, n in enumerate(G.nodes)}
i = 0
for edge in G.edges:
edges.append((mapping[edge[0]], mapping[edge[1]]))
pos = graph_force.layout_from_edge_list(len(G.nodes), edges, iter=1000)
nx.draw(G, {n: pos[i] for n, i in mapping.items()}, node_size=2, width=0.1)
2022-11-20 18:03:45 +00:00
```
## Contributing
- [Development](DEVELOPMENT.md)