Skip to main content

2D and 3D force-directed graph widgets for Jupyter

Project description

ipyforcegraph

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

Install Demo Build Docs
npm-badge
pypi-badge
conda-badge
binder-badge-stable
binder-badge-dev
ci-main-badge
ci-dev-badge
docs-badge
Examples
CHANGELOG
CONTRIBUTING

Screenshots

2D graphs 3D graphs
demos a screenshot of capturing animated 2D graphs a screenshot of capturing animated 3D graphs
text nodes a screenshot of text nodes in 2D a screenshot of text nodes in 2D

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:

Citing ipyforcegraph

doi-badge

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipyforcegraph-0.4.1.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

ipyforcegraph-0.4.1-py3-none-any.whl (985.6 kB view details)

Uploaded Python 3

File details

Details for the file ipyforcegraph-0.4.1.tar.gz.

File metadata

  • Download URL: ipyforcegraph-0.4.1.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.4 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.11.5

File hashes

Hashes for ipyforcegraph-0.4.1.tar.gz
Algorithm Hash digest
SHA256 47cc2907370d6810007402f3e480d627403775201bef02e175199e1fa03cbe43
MD5 2d91afd8a29e3b243817606b02a4931d
BLAKE2b-256 dbc4c1ff37839a88ead5193b7eb2f4faff2bd84a275c564caeef8398bd923e50

See more details on using hashes here.

Provenance

File details

Details for the file ipyforcegraph-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: ipyforcegraph-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 985.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.4 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.11.5

File hashes

Hashes for ipyforcegraph-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd8186fe9bb7c095c069a7347d559161db8a1c40c1e65669a7279e456b061d35
MD5 c581aeaf3f3de58499fecd543e1ac9a6
BLAKE2b-256 cb1411a560ca2e163e336e0a26d8281cdd41fd5aae0e8c2d12b1b4c966dc5f56

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page