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!
The widget is supported in the default Jupyter environments, but also in other environments like VS Code or Google Colab.
Try the Introduction notebook on Google Colab here.
Supported Environments
- JupyterLab or Jupyter Notebook
- Visual Studio Code
- Google Colaboratory
- Google Vertex AI Workbench
- Google Dataproc
- Azure Machine Learning Studio Notebooks
- Amazon SageMaker
- Just try it in your preferred platform for Jupyter notebooks
Requirements
- python >= 3.6
- jupyter notebook or lab
- ipywidgets >= 7.6.0
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
For example code look here.
Google Colab Examples
You can try the example notebooks in Google Colab by
opening GitHub notebook URL: https://colab.research.google.com/github/yWorks/yfiles-jupyter-graphs/blob/main/examples/<notebook.ipynb>.
For example the Introduction notebook:
https://colab.research.google.com/github/yWorks/yfiles-jupyter-graphs/blob/main/examples/01_introduction.ipynb
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.
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yfiles_jupyter_graphs-1.7.3.tar.gz.
File metadata
- Download URL: yfiles_jupyter_graphs-1.7.3.tar.gz
- Upload date:
- Size: 10.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
653cb7434d9b48d3cdf3c96118d439ab552fd4e0946f0076cd7f9cefa68c4bb4
|
|
| MD5 |
723a7db66d286207cc28cb018c0e7168
|
|
| BLAKE2b-256 |
018bc1921412c29c7066825184ea7d760d6d2e78e86c2b6471734e04b5cd2d67
|
File details
Details for the file yfiles_jupyter_graphs-1.7.3-py3-none-any.whl.
File metadata
- Download URL: yfiles_jupyter_graphs-1.7.3-py3-none-any.whl
- Upload date:
- Size: 15.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
55706f0d687263e1e9feca2aa87cd97492d101b976c2027d414538252db30fb4
|
|
| MD5 |
29c47c5cc4dae1d4840f2f7a4c357632
|
|
| BLAKE2b-256 |
eae61aeea0795b9c093d522b9e839dfebc9154c9d12d3b6a6f628a69fce3d81f
|
