Open in new tab

ipyelk#

Jupyter Widgets for interactive graphs powered by the Eclipse Layout Kernel (ELK).

Install

Build

Docs

npm-badge
pypi-badge
conda-badge

ci-badge


Examples
CHANGELOG
CONTRIBUTING

Screenshots#

what can you do…

… with ipyelk

automatically lay out complex, nested data as diagrams

a screenshot of a complex graph

interactive activity/flow-chart diagrams

a screencast of a flowchart with collapsible regions

collapsible blocks

a screencast of a class diagram with collapsible regions

visual simulations

a screencast of an interactive logic gate simulation

embed other widgets in diagrams

a screencast of displaying bar and scatter plots in a flowchart

interact with dynamic systems

a screencast of a predator/prey system with plots over time

Prerequisites#

  • python >=3.10

JupyterLab compatibility#

jupyterlab

ipyelk

special concerns

==1.*

>1

needs nodejs >10
jupyter labextension install @jupyrdf/jupyter-elk
backports, etc. land on the 0.3.x branch

==2.*

>1

untested

==3.*

>=1,<2.1

>=4.1,<5

>=2.1

Install#

ipyelk is distributed on conda-forge and PyPI.

To upgrade from ipyelk 2.x, read Migrating from ipyelk 2.x to 3.0.

ipyelk with pip#

pip install ipyelk "jupyterlab>=4.1,<5"

Developing#

See CONTRIBUTING for a development install.

How it works#

In your kernel, ipyelk:

In your jupyter_server:

In the browser, @jupyrdf/jupyter-elk:

  • ELK lays out the diagram in a WebWorker

  • sprotty draws the diagram as SVG

  • interaction information (like selection and hovering) are passed back to the browser

For upstream widget limitations and their workarounds, see the known issues in the changelog.

Uninstall#

pip uninstall ipyelk

Open Source#

This work is licensed under the BSD-3-Clause License. Some of its source files are derived from other works under the Eclipse Public License 1.0 or 2.0, and it bundles JavaScript packages under the Eclipse Public License 2.0. So the package’s license expression is BSD-3-Clause AND EPL-1.0 AND EPL-2.0.