hqsquantumsimulations / qoqo

qoqo

Quantum Operation Quantum Operation
Yes we use reduplication

qoqo/roqoqo is a toolkit to represent quantum circuits by HQS Quantum Simulations.

For a detailed introduction see the user documentation and the qoqo examples repository

What roqoqo/qoqo is:

• A toolkit to represent quantum programs including circuits and measurement information
• A thin runtime to run quantum measurements
• A way to serialize quantum circuits and measurement information
• A set of optional interfaces to devices, simulators and toolkits (e.g. qoqo_quest, qoqo_mock, qoqo_qasm)

What roqoqo/qoqo is not:

• A decomposer translating circuits to a specific set of gates
• A quantum circuit optimizer
• A collection of quantum algorithms

This repository contains two components:

• roqoqo: the core rust library
• qoqo: the python interface to roqoqo

roqoqo

roqoqo provides:

• A Circuit struct to represent quantum circuits
• A QuantumProgram enum to represent quantum programs using different measurement methods
• Structs representing single-qubit, two-qubit, multi-qubit and measurement operations that can be executed (decomposed) on any universal quantum computer
• Structs representing so-called PRAGMA operations that only apply to certain hardware, simulators or annotate circuits with additional information
• Enums that group operations based on the properties of operations (e.g. Operation for all operations or SingleQubitGateOperation for all unitary operations acting on a single qubit)
• Support for symbolic variables
• Readout based on classical registers
• Measurement structs for evaluating observable measurements based on raw readout date returned by quantum computer backends
• An EvaluatingBackend trait defining a standard for interfacing from qoqo to hardware and simulators that can return measured values
• A Device trait defining a standard to obtain connectivity information and a noise model for quantum computing devices
• Serialize and deserialize support for Circuit and QuantumProgram via the serde crate.

This software is still in the beta stage. Functions and documentation are not yet complete and breaking changes can occur.

Installation

To use roqoqo in a Rust project simply add

roqoqo = {version="1.0"}

to the [dependencies] section of the project Cargo.toml.

qoqo

qoqo provides the Python interface to the underlying roqoqo library, including:

• A Circuit class to represent quantum circuits
• A QuantumProgram class to represent quantum programs
• Classes representing single-qubit, two-qubit, multi-qubit and measurement operations that can be executed (decomposed) on any universal quantum computer
• Classes representing so-called PRAGMA operations that only apply to certain hardware, simulators or annotate circuits with additional information
• Support for symbolic variables
• Readout based on classical registers
• Measurement classes for evaluating observable measurements based on raw readout date returned by quantum computer backends
• Serialization to json and deserialization from json for circuits and measurement information. Serialization support can easily be expanded to other targets with the help of the serde crate.

Installation

On Linux, macOS and Windows on x86 precompiled packages can be found on PyPi and installed via

pip install qoqo

If no pre-built python wheel is available for your architecture you can install qoqo from the source distribution using a rust toolchain (for example available via rustup) and maturin (also available via pip). After installing the rust toolchain and maturing run the same pip install command as above. In some cases on macOS it can be necessary to provide specific linker arguments as shown below:

# can be necessary on mscOS
RUSTFLAGS="-C link-arg=-undefined -C link-arg=dynamic_lookup" pip install qoqo

RUSTFLAGS="-C link-arg=-undefined -C link-arg=dynamic_lookup" maturin build -m qoqo/Cargo.toml  --release
pip install target/wheels/$NAME_OF_WHEEL

When using qoqo in a rust project providing a python interface add

qoqo = {version="1.0", default-features=false}

to the [dependencies] section of the project Cargo.toml.

A source distribution now exists but requires a Rust install with a rust version > 1.47 and a maturin version { >= 0.12, <0.13 } in order to be built.

Examples

Since qoqo provides a full python interface to the underlying roqoqo library, there are examples for python users and for Rust users.

For an expanded collection of examples please see the jupyter notebooks in the extra repository qoqo_examples. The qoqo examples require the qoqo_quest and qoqo_mock interfaces.

• qoqo examples: For jupyter notebooks in python, please refer to qoqo_examples/qoqo/.
• roqoqo examples: The jupyter notebooks in Rust can be found in qoqo_examples/roqoqo/notebooks/. Alternatively, you can also find pure Rust versions of the examples in qoqo_examples/roqoqo/standalone/

This project has been partly supported by PlanQK and is partially supported by QSolid and PhoQuant.

Contributing

We welcome contributions to the project. If you want to contribute code, please have a look at CONTRIBUTE.md for our code contribution guidelines.

qoqo's Issues

Remove Python::acquire_gil() from unittests

Following PyO3/pyo3#1683 Python::acquire_gil() should be deprecated in favour of Python::with_gil().

Python::acquire_gil() will be removed from the main library in #40 but is still used in unittests

KaKDecompositionWrapper for python interface

Create a KaKDecompositionWrapper for qoqo/qoqo/, and uncomment code in qoqo-macros/lib.rs

1-dimensional array requirement for input of PragmaSetDensityMatrix, PragmaGeneralNoise

Currently the inputs for PragmaSetDensityMatrix (density_matrix) and PragmaGeneralNoise (operators) need to be flattened in python using np.flatten before being passed as inputs to the Pragmas. This should be fixed so that these two pragmas take 2d matrices as inputs, without needing to flatten.

qoqo Circuit from_ methods are not classmethods

from_json and from_bincode in qoqo.Circuit are not implemeted as classmethods.

We need to change that so we can call Circuit.from_json(...) directly

Roqoqo documentation - modules

circuit appears on the list of Modules in docs.rs although in lib.rs it says:

#[doc(hidden)]
mod circuit;

It is intended that users access Struct 'Circuit' (not module circuit) in order to get the documentation, so module circuit should be hidden from the Modules list.