roqoqo

roqoqo is the core rust library for qoqo - a toolkit to represent quantum circuits by HQS Quantum Simulations.

For a detailed introduction see the user documentation and the qoqo examples repository. Additionally, the API documentation is available.

What roqoqo 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_qiskit, qoqo_for_braket, qoqo_iqm)

What roqoqo is not:

• A decomposer translating circuits to a specific set of gates

• A quantum circuit optimizer

• A collection of quantum algorithms

If you are looking for a comprehensive package that integrates all these features, we invite you to explore our HQStage software.

Installation

To use roqoqo in a Rust project simply add

roqoqo = {version="1.0"}

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

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.76 and a maturin version { >=1.0 } in order to be built.

Examples

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

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/

Features

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.

Please refer to the API documentation for technical details on roqoqo functionalities.

Support

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

Contribution

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

In order to facilitate the contribution of the addition of a new gate, please also have a look at add_new_gate.md to read a quick explanation of the main steps necessary.

Citation

If you use qoqo, please cite it by including the URL of this github repository, or using the provided BibTeX entry:

@misc{qoqo2021,
      title={qoqo - toolkit to represent quantum circuits},
      author={HQS Quantum Simulations GmbH},
      year={2021},
      url={https://github.com/HQSquantumsimulations/qoqo},
}