qoqo-qryd

Components for the qoqo/roqoqo quantum toolkit by HQS Quantum Simulations that support QRyd quantum computers.

The qoqo-qryd/roqoqo-qryd packages provide three components:

• Backends that execute a compiled qoqo QuantumProgram on QRyd hardware or simulators,
• A set of specific operations only available on QRyd hardware,
• A collection of devices, representations of the Hardware devices available in Qryd.

The /qoqo-qryd folder is there to provide a python interface for the implemented functionalities in /roqoqo-qryd (in rust).

Installation

For the python package we recommend checking out the latest tagged version from github installing it via pip. The pip installation requires rust and cmake to be installed locally. We recommend using rustup to set up a rust toolchain. The pip should also automatically install maturin tool to build a python package locally and install it. Maturin needs an installed rust toolchain.

For a quick installation you can also use:

shell pip install ./qoqo-qryd/qoqo-qryd/

Specifically for macOS on Apple Silicon the following build command should be used:

shell RUSTFLAGS="-C link-arg=-undefined -C link-arg=dynamic_lookup" pip install ./qoqo-qryd/qoqo-qryd/

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

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

The user can also first build a python package with maturin and install it manually. Please note that the package should be built from the top level directory of the workspace selecting the qoqo package with the -m qoqo/Cargo.toml option. A typical build and run command is:

shell maturin build -m qoqo-qryd/Cargo.toml --release pip install target/wheels/$NAME_OF_WHEEL

Using roqoqo-qryd in rust code

For using roqoqo-qryd in rust code including the optional simulator simply add

toml roqoqo-qryd = {version="0.1", path="...", features=["simulator"]}

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

Building rust documentation

To create the API documentation for the roqoqo-qryd rust package run:

bash cd qoqo-qryd/ cargo doc --package=roqoqo-qryd --open

Code coverage

In this project unit tests are written to cover a large percentage of the statements in the source code. To generate a code coverage report for qoqo-qryd please install cargo llvm-cov and use:

bash cargo llvm-cov --package=roqoqo-qryd --open

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