Extension for pytket, providing access to the Stim Clifford simulator
Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimising 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.
pytket-stim is available for Python 3.10, 3.11 and 3.12, 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
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.
To install an extension in editable mode, simply change to its subdirectory
modules directory, and run:
pip install -e .
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.
All code should be formatted using black, with default options. This is checked on the CI. The CI is currently using version 22.3
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
(passing as a single argument the root directory of the module to test). The
mypy 0.800 or above.
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.
To run the tests for a module:
cdinto that module's
- ensure you have installed
hypothesis, and any modules listed in the
test-requirements.txtfile (all via
When adding a new feature, please add a test for it. When fixing a bug, please add a test that demonstrates the fix.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pytket_stim-0.21.0-py3-none-any.whl