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 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 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


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.2.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

ipyelk-0.1.2-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file ipyelk-0.1.2.tar.gz.

File metadata

  • Download URL: ipyelk-0.1.2.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8

File hashes

Hashes for ipyelk-0.1.2.tar.gz
Algorithm Hash digest
SHA256 50b79ee166a2d22e22bdcac968ffa4cdb3ab3c6a032426df65f57286bc79b568
MD5 87cd2c12f0764866abde7123b3a6a679
BLAKE2b-256 512347477c87eb7a9cec1409658c9e15dd15fe4fa6e5f006ea5f8a4e94fed68f

See more details on using hashes here.

File details

Details for the file ipyelk-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ipyelk-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8

File hashes

Hashes for ipyelk-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7140aae2c2c3663ec634227de8d3ad5b85271fd6ae874d95fd1c885c2f59533f
MD5 026ea259353491c23e62009a411438f0
BLAKE2b-256 dba147ad29b96af28db13352ef1bb7c4fc67be4014e4a252ed738fe855836912

See more details on using hashes here.

Supported by

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