Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
pytket-quantinuum
is an extension to pytket
that allows pytket
circuits to
be executed on Quantinuum's quantum devices.
Some useful links:
pytket-quantinuum
is available for Python 3.10, 3.11 and 3.12, on Linux, MacOS
and Windows. To install, run:
pip install pytket-quantinuum
This will install pytket
if it isn't already installed, and add new classes
and methods into the pytket.extensions
namespace.
For example usage of features, see the pytket-quantinuum section of the documentation website.
The knowledge articles also detail experiments using pytket-quantinuum.
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.
In case of questions about the hardware you can contact QCsupport@quantinuum.com.
To install this extension in editable mode, simply change to this directory, and run:
pip install -e .
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.
All code should be formatted using black, with default options. This is checked on the CI. The CI is currently using version 20.8b1.
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 modules/mypy-check
(passing as a single argument the root directory of the module to test). The
script requires 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:
cd
into thetests
directory;- ensure you have installed
pytest
,hypothesis
, and any modules listed in thetest-requirements.txt
file (all viapip
); - 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.