pytket-iqm

Pytket is a python module providing an extensive set of tools for compiling and executing quantum circuits.

pytket-iqm is an extension to pytket that allows pytket circuits to be executed on IQM's quantum devices and simulators.

Getting started

pytket-iqm is available for Python 3.10, 3.11 and 3.12, on Linux, macOS and Windows. To install, run:

pip install pytket-iqm

This will install pytket if it isn't already installed, and add new classes and methods into the pytket.extensions namespace.

API documentation is available here.

Under the hood, pytket-iqm uses iqm-client to interact with the devices. See the IQM Client documentation and Pytket documentation for more info.

To use the integration, initialise an IQMBackend, construct a Pytket circuit, compile it and run. Here is a small example of running a GHZ state circuit:

from pytket.extensions.iqm import IQMBackend
from pytket.circuit import Circuit

backend = IQMBackend(
	url="https://demo.qc.iqm.fi/cocos",
	auth_server_url="https://demo.qc.iqm.fi/auth",
	username="USERNAME",
	password="PASSWORD",
)

circuit = Circuit(3, 3)
circuit.H(0)
circuit.CX(0, 1)
circuit.CX(0, 2)
circuit.measure_all()
compiled_circuit = backend.get_compiled_circuit(circuit)

result = backend.run_circuit(compiled_circuit, n_shots=100)
print(result.get_shots())

The IQM Client documentation includes the [set of currently supported instructions] (https://iqm-finland.github.io/iqm-client/api/iqm_client.iqm_client.html). pytket-iqm retrieves the set from the IQM backend during the initialisation; then get_compiled_circuit() takes care of compiling the circuit into the form suitable to run on the backend.

During the backend initialisation, pytket-iqm also retrieves the names of physical qubits and qubit connectivity. You can override the qubit connectivity by providing the arch parameter to the IQMBackend constructor, but it generally does not make sense, since the IQM server reports the valid quantum architecture relevant to the given backend URL.

(Note: At the moment IQM does not provide a quantum computing service open to the general public. Please contact our sales team to set up your access to an IQM quantum computer.)

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 develop 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.

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:

cd tests
pip install -r test-requirements.txt
pytest

By default, the remote tests, which run against the real backend server, are skipped. To enable them, set the following environment variables:

export PYTKET_RUN_REMOTE_TESTS=1
export PYTKET_REMOTE_IQM_AUTH_SERVER_URL=https://demo.qc.iqm.fi/auth
export PYTKET_REMOTE_IQM_USERNAME=YOUR_USERNAME
export PYTKET_REMOTE_IQM_PASSWORD=YOUR_PASSWORD

When adding a new feature, please add a test for it. When fixing a bug, please add a test that demonstrates the fix.