ipyelk

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

Install

Demo

Build

Docs

npm-badge
pypi-badge
conda-badge

binder-badge

ci-badge


Examples
CHANGELOG
CONTRIBUTING

Screenshots

what can you do…

… with ipyelk

automatically lay out complex, nested data as diagrams

interactive activity/flow-chart diagrams

collapsible blocks

visual simulations

Prerequisites

  • python >=3.7

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

Install

ipyelk is distributed on conda-forge and PyPI.

ipyelk with pip

install nodejs with a package manager

pip install ipyelk jupyterlab=3

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

Uninstall

pip uninstall ipyelk