README.md

ipyforcegraph

Jupyter Widgets for interactive 2D and 3D graphs powered by the force-graph and 3d-force-graph libraries.

Install	Demo	Build	Docs
			Examples CHANGELOG CONTRIBUTING

Screenshots

	2D graphs	3D graphs
demos
text nodes

Prerequisites

• python >=3.8
• jupyterlab >=3

Install

ipyforcegraph is distributed on conda-forge and PyPI.

Installing ipyforcegraph with mamba (recommended)

mamba install -c conda-forge ipyforcegraph jupyterlab

... or conda, if you must

Installing ipyforcegraph with pip

install nodejs with a package manager

pip install ipyforcegraph jupyterlab=3

Installing development ipyforcegraph with pip

Relying on this distribution for any purpose outside of testing is strongly discouraged.

The latest development release is also published along with the documentation. Replacing X.Y.Z with the current version of dev, the following should give the latest snapshot.

pip install -U https://ipyforcegraph.rtfd.io/en/latest/_static/ipyforcegraph-X.Y.Z-py3-none-any.whl

... or

pip install -U https://ipyforcegraph.rtfd.io/en/latest/_static/ipyforcegraph-X.Y.Z.tar.gz

Developing

See CONTRIBUTING for a development install.

How it works

• Provide Sources of nodes and links as e.g. pandas.DataFrames
• Annotate with Behaviors such as NodeSelection and LinkColor
• Visualize and interact with the graph in JupyterLab (or JupyterLite)

Uninstall

mamba uninstall ipyforcegraph

... or conda, if you must

pip uninstall ipyforcegraph

Open Source

This work is licensed under the BSD-3-Clause License.

This work would not be possible without substantial efforts of this project's upstream dependencies, with a special thanks to:

• force-graph
• 3d-force-graph

Citing ipyforcegraph

If ipyforcegraph has been significant in your research, and you would like to acknowledge the project in an academic publication, please download a citation in your preferred format from Zenodo.