Skip to main content

A diagram visualization extension for JupyterLab and Jupyter Notebooks powered by yFiles for HTML

Project description

yFiles Graphs for Jupyter logo

PyPI version

A graph diagram visualization widget for Jupyter Notebooks and Labs powered by yFiles for HTML.

Easily visualize graphs from various sources: Networkx✅, igraph✅, neo4j✅, pygraphviz✅, and any structured Python dictionaries and lists. Many more formats supported indirectly via Networkx imports!

A screenshot showing the yFiles graph widget in a jupyter lab notebook

Supported Environments

Requirements

Installation

If you already have Jupyter installed, just pip install the prebuilt extension from the Python Package Index.

pip install yfiles_jupyter_graphs

If you want to start clean and get a fresh new Jupyter Lab with the widget readily installed and available, you can use docker, too:

Form a shell, create a docker image that contains all that is required:

mkdir yfiles-jupyter && cd yfiles-jupyter
echo -e "FROM jupyter/scipy-notebook\nRUN pip install yfiles-jupyter-graphs" > Dockerfile
docker build -t yfiles-jupyter-graphs-on-docker .

(the above has been tested successfully with scipy-notebook:lab-3.4.7 and yfiles-jupyter-graphs==1.2.1), but we want to make sure that it will also work with upcoming versions - file an issue if it doesn't work for you!)

You can then create a fresh new instance of your server from this image like so:

docker run -it -p 8888:8888 --name yfiles-jupyter yfiles-jupyter-graphs-on-docker

Usage

In a notebook which has the wiget installed in the server, in a Python cell, you can then do this:

"""Execute in jupyter notebook or jupyter lab"""
from yfiles_jupyter_graphs import GraphWidget
# shows empty widget
GraphWidget()

You can find the full documentation here.

Features

neighborhood sidebar See Node Neighborhood layouts Choose Graph Layout
data sidebar Investigate Nodes or Edges Data search sidebar Search for Nodes or Edges
importer Import Graph Data element color mapping Make Data Dependent Property Changes

For example code look here.

Documentation

You can find the documentation here.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@yworks.com.

Feedback

This widget is by no means perfect. If you find something is not working as expected we are glad to receive an issue report from you. Please make sure to search for existing issues first and check if the issue is not an unsupported feature or known issue. If you did not find anything related, report a new issue with necessary information. Please also provide a clear and descriptive title and stick to the issue templates. See issues.

Dependencies

License

See LICENSE file.

Project details


Download files

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

Source Distribution

yfiles_jupyter_graphs-1.4.3.tar.gz (7.9 MB view details)

Uploaded Source

Built Distribution

yfiles_jupyter_graphs-1.4.3-py2.py3-none-any.whl (14.8 MB view details)

Uploaded Python 2Python 3

File details

Details for the file yfiles_jupyter_graphs-1.4.3.tar.gz.

File metadata

  • Download URL: yfiles_jupyter_graphs-1.4.3.tar.gz
  • Upload date:
  • Size: 7.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for yfiles_jupyter_graphs-1.4.3.tar.gz
Algorithm Hash digest
SHA256 a9e26928e2c6f78c39c96b42fbabf6ec32bda2483bdd0170f58a7826b0626ae9
MD5 a03e0bcf4b510106c71facfc07e1f79a
BLAKE2b-256 8f59ece681e78693bc694fe96d558a61bad4222ff55f1cb1a97f37cafee2379b

See more details on using hashes here.

File details

Details for the file yfiles_jupyter_graphs-1.4.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for yfiles_jupyter_graphs-1.4.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cbbb6069b9e10216519847dacbbe6ffcf7c54b84effcba5a16b90941d166363e
MD5 fe082d80c98f2f5d17012fcb5dff107e
BLAKE2b-256 f1cc8aef5a1b8df3a1b9049de39c965a0cb3ee614fec99eda1a52251161eadc2

See more details on using hashes here.

Supported by

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