Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 3.01 KB

README.md

File metadata and controls

78 lines (56 loc) · 3.01 KB
Raw

jupyterlab-dagitty

Github Actions Status Binder PyPI version

A JupyterLab extension for rendering dagitty DAG files (.dag or .dagitty), Python and R notebooks. This extension will also work with upcoming Jupyter Notebook v7+.

Screenshot of rendered DAG

In addition to built-in dagitty interactions (moving nodes and edges), you can use:

  • Ctrl + mouse wheel to zoom in/out,
  • Ctrl + mouse click and drag to move the canvas,
  • resize the plot by dragging bottom-right corner.

You can also make the plot mutable to add nodes or edges (although changes will not be saved).

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