ELK widget for Jupyter
Project description
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 >10jupyter labextension install @jupyrdf/jupyter-elkbackports, 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-elkassets 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.
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-2.1.1.tar.gz
(2.9 MB
view details)
Built Distribution
File details
Details for the file ipyelk-2.1.1.tar.gz.
File metadata
- Download URL: ipyelk-2.1.1.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 57d59a911663abe392aa4bf302445c66aa800a0751da30df3a0c08478532a808 |
|
| MD5 | 7e24da80d6dd7b841694c449a8f9e215 |
|
| BLAKE2b-256 | d529796e025bdb77f1f74fd2e37c0cf2ca7b5ab96c41e7d90c4454f58834d56e |
File details
Details for the file ipyelk-2.1.1-py3-none-any.whl.
File metadata
- Download URL: ipyelk-2.1.1-py3-none-any.whl
- Upload date:
- Size: 3.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 431c02369cb783ba470ad6b00f78bff772b3dda7bff514628102e26cfce4dc7a |
|
| MD5 | 7cd139f5d6fddcd83abc94a970b2a6ba |
|
| BLAKE2b-256 | 3b3a747f7451eab44885f0d6f0cc19f79763a717a81edf930393e5b076370b9d |
