https://github.com/cqcl/pytket-stim
pytket-stim, extensions for pytket quantum SDK
https://github.com/cqcl/pytket-stim
Last synced: about 1 year ago
JSON representation
pytket-stim, extensions for pytket quantum SDK
- Host: GitHub
- URL: https://github.com/cqcl/pytket-stim
- Owner: CQCL
- License: apache-2.0
- Created: 2022-10-05T13:14:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-25T13:01:53.000Z (about 1 year ago)
- Last Synced: 2025-05-07T04:47:20.035Z (about 1 year ago)
- Language: Python
- Size: 5.85 MB
- Stars: 1
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# pytket-stim
[](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#)
[](https://quantumcomputing.stackexchange.com/tags/pytket)
[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
[Stim](https://github.com/quantumlib/Stim) is a fast Clifford circuit simulator.
`pytket-stim` is an extension to `pytket` that allows `pytket` circuits to be
simulated using Stim.
Some useful links:
- [API Documentation](https://tket.quantinuum.com/extensions/pytket-stim/)
## Getting started
`pytket-stim` is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS
and Windows. To install, run:
```shell
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](https://github.com/CQCL/pytket-stim/issues).
There is also a Slack channel for discussion and support. Click [here](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#/shared-invite/email) to join.
## Development
To install an extension in editable mode, simply change to its subdirectory
within the `modules` directory, and run:
```shell
pip install -e .
```
## 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
[black](https://black.readthedocs.io/en/stable/), with default options. This is
checked on the CI. The CI is currently using version 22.3
#### Type annotation
On the CI, [mypy](https://mypy.readthedocs.io/en/stable/) 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](https://pypi.org/project/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.