Installation

Qanary requires Python 3.13. Install the latest release from PyPI:

uv add qanary

pip install qanary

Migrating from QCUtils

Qanary is the renamed successor to QCUtils. Replace the qcutils dependency with qanary, change imports from qcutils... to qanary..., and rename QCUTILS_HOME to QANARY_HOME. The default application directory has likewise changed from ~/.qcutils to ~/.qanary.

Qanary pulls in its QCoDeS, Zurich Instruments, live-visualization (qimchi-connect) and instrument driver (qcdrivers) dependencies, so there is no need to add them separately.

Development installation

To work on Qanary itself, clone the repository and install its development and test tools:

git clone https://gitlab.com/squad-lab/qanary.git
cd qanary
uv sync --extra dev
uv run pre-commit install

Optional extras

Extra	Installs	Use it for
test	pytest, pytest-cov	Running the test suite
dev	pre-commit, Ruff, and test tools	Contributing to Qanary

uv sync --extra test
uv run pytest

The documentation dependencies live in a dependency group rather than an extra:

uv sync --group docs
uv run sphinx-build -M html docs/source docs/build