The missing 3D plotting functionality for networkx
Project description
nx3d
The missing 3D plotting functionality for the excellent networkx
Python package.
Installation
In your shell:
pip install nx3d
Quickstart
After installation,
From your shell
python -m nx3d autolabel
or
python -m nx3d diffusion
In your Python REPL
import nx3d
nx3d.demo()
Usage
In your Python code:
import networkx as nx
import nx3d
g = nx.frucht_graph()
nx3d.plot(g)
Contribute
Thank you for considering contributing to nx3d
.
Clone the code
Setup the development environment
You can do this as you like, though you might consider:
- Install
poetry
- Run
poetry shell
- Run
poetry install
- Verify the installation by running
python -m nx3d
Set up pre-commit
The pre-commit hooks defined in .pre-commit-config.yaml
apply linting and formatting to keep the project clean. Please
use the pre-commit hooks to keep code quality high.
From this project's root, initialize pre-commit as follows:
pre-commit install
pre-commit run -a
Update the docs
- Update the inline docstrings and/or the files in the docs/ directory.
- Navigate to the docs/ dir and run
make html
to preview your changes. - When you cut a PR, the CI will trigger a ReadTheDocs build.
- When merged, the CD will publish those docs (3).
First time updating the docs
I used brew install python-sphinx
, see installation instructions on www.sphinx-doc.org.
Hack on some code
See TODO.md for open tasks.
Open a PR
When a PR is created or updated, code checks will be run. When a PR is merged, the code will be pushed to PyPi and the docs to ReadTheDocs.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.