Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krassowski/jupyterlab-dagitty
JupyterLab renderer of dagitty causal diagrams
https://github.com/krassowski/jupyterlab-dagitty
causal-inference causal-models directed-acyclic-graph ipython-display irkernel jupyterlab-extension
Last synced: about 2 months ago
JSON representation
JupyterLab renderer of dagitty causal diagrams
- Host: GitHub
- URL: https://github.com/krassowski/jupyterlab-dagitty
- Owner: krassowski
- License: lgpl-2.1
- Created: 2022-07-28T13:59:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T22:03:27.000Z (over 1 year ago)
- Last Synced: 2024-10-13T11:57:15.642Z (3 months ago)
- Topics: causal-inference, causal-models, directed-acyclic-graph, ipython-display, irkernel, jupyterlab-extension
- Language: TypeScript
- Homepage:
- Size: 1.46 MB
- Stars: 20
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jupyterlab-dagitty
[](https://mybinder.org/v2/gh/krassowski/jupyterlab-dagitty/main?urlpath=lab/tree/examples/car_model_driver.dag)
[](https://pypi.org/project/jupyterlab-dagitty/)
A JupyterLab extension for rendering [dagitty](http://dagitty.net/) DAG files (`.dag` or `.dagitty`),
[Python](https://mybinder.org/v2/gh/krassowski/jupyterlab-dagitty/main?urlpath=lab/tree/examples/Python_demo.ipynb) and
[R](https://mybinder.org/v2/gh/krassowski/jupyterlab-dagitty/main?urlpath=lab/tree/examples/R_demo.ipynb)
notebooks. This extension will also work with upcoming Jupyter Notebook v7+.
![Screenshot of rendered DAG][screenshot]
[screenshot]: https://raw.githubusercontent.com/krassowski/jupyterlab-dagitty/main/docs/images/screenshot.png
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
```bash
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](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# 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.
```bash
# 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:
```bash
jupyter lab build --minimize=False
```
### Uninstall
```bash
pip uninstall jupyterlab-dagitty
jupyter labextension uninstall jupyterlab-dagitty
```