requirements + minimal readme

This commit is contained in:
Niko Abeler 2022-11-20 17:14:34 +01:00
parent 50a15a158c
commit b6e4744210
2 changed files with 23 additions and 1 deletions

View File

@ -1,4 +1,25 @@
# Force Graph # Graph Force
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
### Setup
```
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
### Build
```
maturin develop
```
## Usage
```python
import graph_force
edges = [(0, 1), (1, 2), (2, 3), (3, 0)]
pos = graph_force.layout_from_edge_list(4, edges)
```

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
maturin==0.14.1