@jupyrdf/jupyter-elk
v2.1.1
Published
ElkJS widget for Jupyter
Downloads
148
Readme
ipyelk
Jupyter Widgets for interactive graphs powered by the Eclipse Layout Kernel (ELK).
| Install | Build | Docs | | :-----------------------------------------------------------------------------------: | :-----------------: | :----------------------------------------------------------------------------------: | | | | 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 | |
| embed other widgets in diagrams | |
| interact with dynamic systems | |
Prerequisites
python >=3.9
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.
ipyelk
with conda
(recommended)
conda install -c conda-forge ipyelk "jupyterlab=4.*"
# or
mamba install -c conda-forge ipyelk "jupyterlab=4.*"
ipyelk
with pip
pip install ipyelk "jupyterlab=4.*"
Developing
See CONTRIBUTING for a development install.
How it works
In your kernel, ipyelk
:
In your jupyter_server
:
- serve the
@jupyrdf/jupyter-elk
assets as a federated module
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
Open Source
This work is licensed under the BSD-3-Clause License. It contains pieces derived from other works.