pytket is a python module for interfacing with CQC t|ket>, a set of quantum programming tools.
This repo contains API documentation and example notebooks to get you started using pytket. It does not contain source code.
pytket is available for python3.6 or higher, on Linux, MacOS and Windows.
To install, ensure that you have pip version 19 or above, and run
pip install pytket
Note: attempting to install from source will not set up the required binaries for the t|ket> compiler, so we recommend the PyPI installation.
See the Getting Started page for a quick introduction to using pytket.
Documentation can be found at cqcl.github.io/pytket
To get more in depth on features, see the examples.
We currently support circuits and device architectures from Google Cirq, IBM Qiskit, Pyzx, ProjectQ, Rigetti pyQuil, AQT, Honeywell, Microsoft QDK, Amazon Braket, and Qulacs, allowing the t|ket> tools to be used in conjunction with projects on these platforms.
To use pytket in conjunction with other platforms you must download an additional separate module for each.
This can be done from pip.
For each subpackage:
- Qiskit:
pip install pytket-qiskit - Cirq:
pip install pytket-cirq - PyQuil:
pip install pytket-pyquil - ProjectQ:
pip install pytket-projectq - PyZX:
pip install pytket-pyzx - AQT:
pip install pytket-aqt - Honeywell:
pip install pytket-honeywell - Q#:
pip install pytket-qsharp - Braket:
pip install pytket-braket - Qulacs:
pip install pytket-qulacs
Copyright 2019-2020 Cambridge Quantum Computing
Licensed under a Non-Commercial Use Software Licence (the "Licence"); you may not use this product except in compliance with the Licence. You may obtain a copy of the Licence in the LICENCE file accompanying these documents or view them here.
Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence, but note it is strictly for non-commercial use.
If you wish to cite tket in any academic publications, we generally recommend citing our software overview paper for most cases.
If your work is on the topic of specific compilation tasks, it may be more appropriate to cite one of our other papers:
- "On the qubit routing problem" for qubit placement (aka allocation, mapping) and routing (aka swap network insertion, connectivity solving).
- "Phase Gadget Synthesis for Shallow Circuits" for representing exponentiated Pauli operators in the ZX calculus and their circuit decompositions.
- "A Generic Compilation Strategy for the Unitary Coupled Cluster Ansatz" for sequencing of terms in Trotterisation and Pauli diagonalisation.
We are also keen for others to benchmark their compilation techniques against us. We recommend checking our benchmark repository for examples on how to run basic benchmarks with the latest version of pytket. Please list the release version of pytket with any benchmarks you give, and feel free to get in touch for any assistance needed in setting up fair and representative tests.