Installation

Basic

To install bartiq run:

pip install bartiq

Info

If you wish to use the package's jupyter integrations, run pip install "bartiq[jupyter]" instead.

For a source install run:

# Clone bartiq repo (you can use HTTP link as well)
git clone git@github.com:PsiQ/bartiq.git
cd bartiq
pip install .

Info

If you wish to use the package's jupyter integrations, run pip install ".[jupyter]" instead.

For development we recommend installing using poetry:

git clone git@github.com:PsiQ/bartiq.git
cd bartiq
pip install poetry
poetry install

Info

If you wish to use the package's jupyter integrations, run poetry install -E jupyter instead.

This will create a virtual environment for you and install all developer and docs dependencies within it.

To enter this environment run:

poetry shell

To run the test suite, from the project root directory run:

poetry shell  # If not already in the venv
pytest

To build docs, from the project root directory run:

poetry shell  # If not already in the venv
mkdocs serve