Skip to content

Installation

Via pip

To install bartiq run:

pip install bartiq

Info

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

Note

To use the QREF ⧉ rendering tool in Jupyter Notebook, ensure the Graphviz software is installed on your OS and that its executables are included in your system variables. For installation instructions, please refer to the Graphviz download page ⧉.

From Source

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.

Development

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. For Poetry 2.0 and above, you can enter this environment by running: 

$(poetry env activate)
or, for Poetry 1.x: 
poetry shell

Tests

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

poetry shell  # If not already in the venv
pytest

Documentation

To build docs, from the project root directory run:

poetry shell  # If not already in the venv
mkdocs serve