quantinuum-qircheck

This repository contains the quantinuum_qircheck package.

Getting started

quantinuum_qircheck is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS and Windows. To install, run:

pip install quantinuum_qircheck

Bugs, support and feature requests

Please file bugs and feature requests on the Github issue tracker.

There is also a Slack channel for discussion and support. Click here to join.

Development

Install the project and development tools with uv:

uv sync --group dev

Install local git hooks with prek:

uvx prek install

You could also use make targets such as:

make install    # for installation
make dev        # install the project with lint and test tooling
make lint       # run formatting, linting, and type checking
make tests      # for running tests
make build      # for source and wheel distribution packages
make clean      # to clean up autogenerated files

To run the hook suite manually:

uvx prek run --all-files

Contributing

Pull requests are welcome. To make a PR, first fork the repo, make your proposed changes on the main branch, and open a PR from your fork. If it passes tests and is accepted after review, it will be merged in.

Code style

Formatting

All code should be formatted using ruff format. This is checked on the CI.

Type annotation

On the CI, ty is used as a static type checker and all submissions must pass its checks. You should therefore run uv run ty check quantinuum_qircheck tests locally on any changed files before submitting a PR.

Linting

We use ruff on the CI to check compliance with a set of style requirements (listed in pyproject.toml).

An easy way to meet all formatting and linting requirements is to run make lint or uvx prek run --all-files before sending a PR.

Tests

To run the tests:

1. run uv sync --group test if you have not already installed the test dependencies;
2. run uv run pytest.

When adding a new feature, please add a test for it. When fixing a bug, please add a test that demonstrates the fix.