DEV Instructions

Installation

First, ensure the repository is cloned and you are on the right branch

The following commands assume that you are inside the root directory of the package (i.e. the directory containing pyproject.toml).

git checkout <branch-name>
pip install -e .

Alternatively, a command with the absolute path can be used:

py -m pip install -e <absolute/path/to/repo/root/directory>

or

pip install -e <absolute/path/to/repo/root/directory>

Example Notebooks

Usage Overview Notebook