Skip to main content

ELK widget for Jupyter

Project description

ipyelk

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

Demo Build Docs
binder-badge ci-badge CHANGELOG
CONTRIBUTING
examples

Interactive diagrams with elk.js, sprotty in JupyterLab

Prerequisites

  • python >=3.7
  • jupyterlab >=1,<2 JupyterLab 2+ compatibility coming soon!
  • nodejs >=10,<14

Install

ipyelk is distributed on PyPI. @jupyrdf/jupyter-elk is distributed on npm. Install them with:

pip install ipyelk
jupyter labextension install @jupyter-widgets/jupyterlab-manager @jupyrdf/jupyter-elk

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


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.1.1.tar.gz (22.2 kB view hashes)

Uploaded Source

Built Distribution

ipyelk-0.1.1-py3-none-any.whl (25.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page