Skip to main content

A JupyterLab extension for rendering Dagitty DAG files.

Project description

jupyterlab-dagitty

Github Actions Status Binder PyPI version

A JupyterLab extension for rendering dagitty DAG files (.dag or .dagitty).

Screenshot of rendered DAG

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab-dagitty

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-dagitty directory
# Build dagity distribution (bash script)
bash build_dagitty.sh
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab-dagitty
jupyter labextension uninstall jupyterlab-dagitty

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

jupyterlab-dagitty-0.3.5.tar.gz (131.1 kB view details)

Uploaded Source

Built Distribution

jupyterlab_dagitty-0.3.5-py3-none-any.whl (117.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-dagitty-0.3.5.tar.gz.

File metadata

  • Download URL: jupyterlab-dagitty-0.3.5.tar.gz
  • Upload date:
  • Size: 131.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for jupyterlab-dagitty-0.3.5.tar.gz
Algorithm Hash digest
SHA256 87dd8bf8d9ff7ef439caff56179f5ba194d4ce937734a3effe06b56868bcaf28
MD5 9a5c1efe512c75996b17cd9b0f34a225
BLAKE2b-256 0a94b014a0324ec4243e3805f382efb1c8b486414f0a83fd710c882877307f72

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_dagitty-0.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_dagitty-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 959a210950bd1771c7224e3fc78cc74aaea4c16046a27ca918851592fcaac88f
MD5 3f5f5e4348e67feeabd441fc4515ebaf
BLAKE2b-256 507f69f34cfc5928e3c8965580e9ac2577897169175ba297ee3ff37103041d3e

See more details on using hashes here.

Provenance

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