pytket-qujax 0.20.0

Description:

pytketqujax 0.20.0

pytket-qujax


This repository contains the pytket-qujax extension, using CQC's
pytket quantum SDK.
The other pytket extensions can be found here
Pytket is a Python module for interfacing
with CQC tket, a set of quantum programming tools.
qujax is a pure JAX
quantum simulator. pytket-qujax is an extension to pytket
that allows pytket circuits to
be converted to qujax for fast (classical) simulation and automatic differentiation.
Some useful links:

Documentation
PyPI
qujax
pytket-qujax example notebook (VQE)
pytket-qujax example notebook (QAOA with symbol_map)
pytket-qujax example notebook (classifier)
qujax example notebooks

Getting started
pytket-qujax is available for Python 3.10, 3.11 and 3.12, on Linux and MacOS.
To install, run:
pip install pytket-qujax

This will install pytket if it isn't already installed, and add new classes
and methods into the pytket.extensions namespace.
Bugs and feature requests
Please file bugs and feature requests on the Github
issue tracker.
Development
To install an extension in editable mode, simply change to its subdirectory
within the modules directory, and run:
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, with default options. This is
checked on the CI. The CI is currently using version 20.8b1.
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. 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 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:

cd into that module's tests directory;
ensure you have installed pytest, hypothesis, and any modules listed in
the test-requirements.txt file (all via pip);
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.