install and dev

This commit is contained in:
Niko Abeler 2022-11-20 19:03:45 +01:00
parent 46cac1528c
commit 2d3572e63b
2 changed files with 21 additions and 12 deletions

13
DEVELOPMENT.md Normal file
View File

@ -0,0 +1,13 @@
## Development
### Setup
```
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
### Build
```
maturin develop
```

View File

@ -2,18 +2,10 @@
A python/rust library for embedding graphs in 2D space, using force-directed layouts. A python/rust library for embedding graphs in 2D space, using force-directed layouts.
## Development ## Installation
### Setup ```bash
``` pip install graph_force
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
### Build
```
maturin develop
``` ```
## Usage ## Usage
@ -41,3 +33,7 @@ for edge in G.edges:
pos = graph_force.layout_from_edge_list(len(G.nodes), edges, iter=1000) 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) nx.draw(G, {n: pos[i] for n, i in mapping.items()}, node_size=2, width=0.1)
``` ```
## Contributing
- [Development](DEVELOPMENT.md)