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.

Source Distribution

ipyelk-1.0.0.tar.gz (588.4 kB view details)

Uploaded Source

Built Distribution

ipyelk-1.0.0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipyelk-1.0.0.tar.gz
  • Upload date:
  • Size: 588.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for ipyelk-1.0.0.tar.gz
Algorithm Hash digest
SHA256 939d0a33fd3f6a4674128dcc6d59ea582633acc58905bd0150208487ec2444ef
MD5 0d7b28fc5c39338574b45c269e4efa8c
BLAKE2b-256 26ce87565824f7915a897839a3bc25768c9acdbee905fadbdd74d52dc7f76193

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyelk-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for ipyelk-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5d387011882caeab9c93755d43c96558cabf6c90c0cc5c0458a453286796ff8
MD5 78c0862d13442b210b14614c5f66fc3d
BLAKE2b-256 31dc5256414a2fde2c4cd43dfe0f603db8a1b30f042922194300f333e8683cbf

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