ELK widget for Jupyter
Project description
ipyelk
Jupyter Widgets for interactive graphs powered by the Eclipse Layout Kernel (ELK).
Install | Demo | Build | Docs |
---|---|---|---|
|
CHANGELOG CONTRIBUTING examples |
Prerequisites
python >=3.7
jupyterlab >=1,<2
JupyterLab 2+ compatibility coming soon!nodejs >=10,<14
Install
ipyelk
is distributed on conda-forge and PyPI.
ipyelk
with conda
(recommended)
conda
can also install nodejs
.
conda install -c conda-forge ipyelk jupyterlab=1 nodejs
ipyelk
with pip
install nodejs
with a package manager
pip install ipyelk jupyterlab=1
@jupyrdf/jupyter-elk
with jupyter labextension install
@jupyrdf/jupyter-elk
is distributed on npm, and relies on
@jupyter-widgets/jupyterlab-manager
.
jupyter labextension install @jupyter-widgets/jupyterlab-manager @jupyrdf/jupyter-elk
Developing
See CONTRIBUTING for a development install.
How it works
In your kernel, ipyelk
:
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
jupyter labextension uninstall @jupyrdf/jupyter-elk
Open Source
This work is licensed under the BSD-3-Clause License. It contains pieces derived from other works.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ipyelk-0.2.0.tar.gz
(42.0 kB
view hashes)
Built Distribution
ipyelk-0.2.0-py3-none-any.whl
(53.5 kB
view hashes)