pytket-cirq
Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
pytket-cirq is an extension to pytket that allows pytket circuits to be
executed on Cirq simulators and supported quantum devices.
Some useful links:
Getting started
pytket-cirq is compatible with Python versions 3.10 to 3.13 on Linux, MacOS
and Windows. To install, run:
pip install pytket-cirq
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.
Development
To install an extension in editable mode run:
pip install -e .
We have set up the repo to be used with uv. You can use also:
uv sync --python 3.12
to install the package. This will automatically pick up all requirements for the tests as well.
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, with default options. This is checked on the CI.
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. You can run them with:
uv run mypy --config-file=mypy.ini --no-incremental --explicit-package-bases pytket tests
Linting
We use ruff on the CI to check compliance with a set of style requirements (listed in ruff.toml).
You should run ruff over any changed files before submitting a PR, to catch any issues.
An easy way to meet all formatting and linting requirements is to issue pre-commit run --all-files.
If you are using uv running uv run pre-commit run --all-files --show-diff-on-failure will install the package and run all the checks.
Tests
To run the tests for this module:
- ensure you have installed
pytest,hypothesis, and any modules listed in thedev-dependenciessection of thepyproject.tomlfile; (If you are using uv this will be picked up automatically.) - 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.
5 maintainers
Release files for pytket-cirq 0.43.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytket_cirq-0.43.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / pytket_cirq-0.43.0-py3-none-any.whl
| Download URL | pytket_cirq-0.43.0-py3-none-any.whl |
|---|---|
| Size | 26.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b40f259bd7761908040e53dadad655543bb99dac41836ffeb96f32ac6a6f6b9a
|
|
BLAKE2b-256 checksum How to use checksums |
6813fbf0640efd753e9627ec0e4c915cdd92203e3e1a18f543b00c9cb20f9ad7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
