pytket-qiskit
Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
pytket-qiskit is an extension to pytket that allows pytket circuits to be
executed on IBM Quantum backends and simulators via Qiskit, and provides conversion utilities between pytket and Qiskit circuit representations.
Some useful links:
Getting started
pytket-qiskit is compatible with Python versions 3.10 to 3.13 on Linux, MacOS
and Windows. To install, run:
pip install pytket-qiskit
This will install pytket if it isn't already installed, and add new classes
and methods into the pytket.extensions namespace.
To use Aer simulators and IBMQ emulators with pytket-qiskit, install with the
aer option:
pip install pytket-qiskit[aer]
However, note that qiskit_aer is no longer actively maintained and will not
be compatible with the most recent Python versions.
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.
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pytket_qiskit-0.78.0-py3-none-any.whl.
File metadata
- Download URL: pytket_qiskit-0.78.0-py3-none-any.whl
- Upload date:
- Size: 91.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4143a5da822ff8dcbe17a3189d7d8be18cde3f292368e9ba568987794f14e333
|
|
| MD5 |
4257b126918d66e6feb572ca39c4d196
|
|
| BLAKE2b-256 |
bf9fcbf51a4f3e8a7b3aafd33d6fb311eaa15af12ab26e0875d9581f615eb5fb
|
