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

Uploaded Source

Built Distribution

ipyelk-0.2.1-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipyelk-0.2.1.tar.gz
  • Upload date:
  • Size: 43.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.8

File hashes

Hashes for ipyelk-0.2.1.tar.gz
Algorithm Hash digest
SHA256 b3907ef9548e7946c67393a7094751f7ca83bee3fd28d1e0120cde7dc0a33a0a
MD5 eff986aa6564ec641b690109dca94912
BLAKE2b-256 336e99d4930a5e1729a12f18371bab2c31a32ffef86ef694c99d71bbc158a86d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyelk-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 55.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.8

File hashes

Hashes for ipyelk-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8c3949b318cea7492f6552291079fdffbaef23e3849de6ba4bef16c893ccf3bb
MD5 8d47b3aa3016fbf1b8838f3e310fb554
BLAKE2b-256 73b807619add65bb4b68319722594599da556b555a83d6520341af112e863c0c

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