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.

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

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:

Usage

"""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.3.1.tar.gz (7.8 MB view details)

Uploaded Source

Built Distribution

yfiles_jupyter_graphs-1.3.1-py2.py3-none-any.whl (14.6 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: yfiles_jupyter_graphs-1.3.1.tar.gz
  • Upload date:
  • Size: 7.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for yfiles_jupyter_graphs-1.3.1.tar.gz
Algorithm Hash digest
SHA256 774bc63e04e888a1c9d3c0d78ffa8579e3b1da820661f6fd2c9063b442829877
MD5 6061f97bdcf9573bb3268c9a94e735be
BLAKE2b-256 2652c237c4dc35c8d004d7731bf6370dc4680081e9580747f81e9892da6fb257

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for yfiles_jupyter_graphs-1.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 88d271801575ba2c08ef11f0c692fee8ce95d4afb90bd4250070332665158832
MD5 693097cd41fdb836ad79f84c550791b3
BLAKE2b-256 80f9ca633dfdf3b6de93c9c78dde2b3bfffc448551728e3cf1cb2df85d68f296

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