Skip to main content

ELK widget for Jupyter

Project description

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 conda (recommended)

conda install -c conda-forge ipyelk jupyterlab=3

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

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.

Files for ipyelk, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size ipyelk-1.0.0-py3-none-any.whl (1.2 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ipyelk-1.0.0.tar.gz (588.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page