pytket-stim 0.14.0rc0

Extension for pytket, providing access to the Stim Clifford simulator

Pytket Extensions

This repository contains the pytket-stim extension, using Quantinuum's pytket quantum SDK.

pytket-stim

Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimisation compiler developed by Quantinuum.

Stim is a fast Clifford circuit simulator.

pytket-stim is an extension to pytket that allows pytket circuits to be simulated using Stim.

Getting started

pytket-stim is available for Python 3.8, 3.9 and 3.10, on Linux, MacOS and Windows. To install, run:

pip install pytket-stim

This will install pytket if it isn't already installed, and add new classes and methods into the pytket.extensions namespace.

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

To install an extension in editable mode, simply change to its subdirectory within the modules directory, and run:

pip install -e .

Contributing

Pull requests are welcome. To make a PR, first fork the repo, make your proposed changes on the develop 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 black, with default options. This is checked on the CI. The CI is currently using version 20.8b1.

Type annotation

On the CI, mypy is used as a static type checker and all submissions must pass its checks. You should therefore run mypy locally on any changed files before submitting a PR. Because of the way extension modules embed themselves into the pytket namespace this is a little complicated, but it should be sufficient to run the script modules/mypy-check (passing as a single argument the root directory of the module to test). The script requires mypy 0.800 or above.

Linting

We use pylint on the CI to check compliance with a set of style requirements (listed in .pylintrc). You should run pylint over any changed files before submitting a PR, to catch any issues.

Tests

To run the tests for a module:

1. cd into that module's tests directory;
2. ensure you have installed pytest, hypothesis, and any modules listed in the test-requirements.txt file (all via pip);
3. 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.