From 2d3572e63b1096e9173b53a5bc9a8bdb141c78d6 Mon Sep 17 00:00:00 2001 From: Niko Abeler Date: Sun, 20 Nov 2022 19:03:45 +0100 Subject: [PATCH] install and dev --- DEVELOPMENT.md | 13 +++++++++++++ README.md | 20 ++++++++------------ 2 files changed, 21 insertions(+), 12 deletions(-) create mode 100644 DEVELOPMENT.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..9554f9f --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,13 @@ +## Development + +### Setup +``` +python3 -m venv venv +source venv/bin/activate +pip install -r requirements.txt +``` + +### Build +``` +maturin develop +``` \ No newline at end of file diff --git a/README.md b/README.md index ec4ac56..32db68e 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,10 @@ A python/rust library for embedding graphs in 2D space, using force-directed layouts. -## Development +## Installation -### Setup -``` -python3 -m venv venv -source venv/bin/activate -pip install -r requirements.txt -``` - -### Build -``` -maturin develop +```bash +pip install graph_force ``` ## Usage @@ -40,4 +32,8 @@ for edge in G.edges: 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) -``` \ No newline at end of file +``` + +## Contributing + +- [Development](DEVELOPMENT.md) \ No newline at end of file