42 releases (11 breaking)

0.16.0 Apr 8, 2024
0.15.0 Mar 25, 2024
0.12.0 Dec 12, 2023
0.11.8-alpha.0 Nov 29, 2023
0.5.4 Jul 20, 2022

#70 in Simulation

Download history 17/week @ 2024-01-19 18/week @ 2024-02-09 10/week @ 2024-02-16 420/week @ 2024-02-23 322/week @ 2024-03-01 19/week @ 2024-03-08 6/week @ 2024-03-15 127/week @ 2024-03-22 37/week @ 2024-03-29 241/week @ 2024-04-05

412 downloads per month


6.5K SLoC


GitHub Workflow Status PyPI PyPI - Format Crates.io Crates.io

The qoqo-qryd python package implements modules to support qoqo usage with quantum computers and quantum computer emulators of the QRydDemo project.

The QRydDemo project builds on quantum computers using Rydberg atoms. qoqo is quantum computing toolkit by HQS Quantum Simulations.

The qoqo-qryd package contains the following functionality:

Interface to the current QRydDemo WebAPI

At the moment QRydDemo WebAPI allows access to Quantum Hardware Emulators of different device topology. qoqo-qryd supports interfacing with the corresponding REST-API with low level calls as well as a high-level backend to qoqo quantum programs. For this it provides the backend APIBackend to evaluate qoqo quantum programs and the api_devices module to represent devices available on the emulators.

QRydDemo specific hardware operations (prototype)

Rydberg atom based quantum devices support, in principle, operations not commonly found in other quantum hardware. Changes in device topology are one of these operations. qoqo-qryd adds support for changes in device topology to qoqo via the operations in its pragma_operations module. Note that this is a preview prototype and does not represent a finalized set of operations on the QRydDemo hardware.

Local simulator supporting specific hardware operations

qoqo-qryd includes a local QuEST based simulator for quantum devices supporting the Rydberg specific quantum operations. The simulator is intended to let users test the capabilities of quantum hardware with the additional operations. qoqo-qryd provides the simulator via the SimulatorBackend qoqo-compatible backend that uses the device prototypes in its qryd_devices module. Note that the devices for the simulator do not represent a finalized design for QRydDemo.

Accessing QRydDemo WebAPI

To use the WebAPI, a QRydDemo account is required. Users can register via the online registration form.


The qoqo-qryd package is available on PyPi as a source distribution and as precompiled wheels for linux and macOS on the x86 platform. Other platforms need to install from the source distribution.

For both source distribution and pre-built wheels it can be installed via

pip install qoqo-qryd

When building from source qoqo-qryd requires rust, maturin and cmake to be installed locally. We recommend using rustup to set up a rust toolchain. The pip command should also automatically install maturin to build a python package locally and install it.

For a quick installation of the dependencies you can also use:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
pip install maturin


The user documentation is provided on github pages. The API-documentation for qoqo-qryd can be found as an appendix of the user documentation.


A small collection of example python scripts for the QRydDemo project can be found in the project github repository. The examples include

  • howto_webapi_qoqo.ipynb provides an example accessing the QRydDemo's emulator with qoqo.
  • switch_layout_example.py shows how to construct a QRydDemo device and using the PragmaChangeQrydLayout operation to switch between layouts in a quantum Circuit.
  • shift_qubits_example.py shows how to construct a QRydDemo device and using the PragmaShiftQrydQubit operation to shift qubits between tweezer positions in a quantum Circuit.
  • multi_qubit_example.py shows how to use multi-qubit-operations.
  • serialisation_example.py demonstrates how to serialize a QuantumProgram to JSON format.


Acknowledgments related to using OpenSSL for http requests:

"This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)."

This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com).


~514K SLoC