QUA Libraries

Hey! Glad to see you there!

Welcome to the QUA libraries. Your one-stop-shop for a batteries-included QUA experience.

This repo is where we share the general-purpose tutorials and tools that aren't tied to any particular qubit platform, and it points you to the platform-specific libraries below.

It includes:

• The "Tutorials" folder contains various tutorials and guides for working with the OPX — timing, streams, demodulation, simulation, macros, Octave, and more.

Installing

Install qua-libs-core from PyPI:

pip install qua-libs-core

That gives you the importable qua_libs_core package, including qua_libs_core.telemetry used across the qua-libs repositories, without the QUA SDK.

Or clone this repository for tutorials and the installer in addition to telemetry:

git clone https://github.com/qua-platform/qua-libs-core
cd qua-libs-core
uv sync --extra tutorials

qua_libs_core.telemetry can keep a record of your runs — which script ran, how long each step took, and whether it worked — in a file on your own machine. It is off unless you turn it on; see the telemetry documentation.

QUA Libraries installer

For a batteries-included modality setup (clone, virtual environment, QUAlibrate, and optionally run recording), use tools/installer/. See the installer telemetry notes for what it sets up.

QUA libraries by platform

Examples, use cases, and calibration protocols for specific qubit platforms live in their own repositories:

Support and Contribution

This is a beta version of the repo, and thus, if you see quirks and inaccuracies please tell us! Love to see some example that's not yet included? tell us! Have a request for a general purpose procedure? tell us! Already have something cool that others could use? Open a pull request! You can follow this guide and feel free to contact us if you need any help. Issue reporting and requests should be done via the GitHub issues system, that should give a transparent experience where all users can see what's coming and which issues are already known. We hope this repo becomes a useful resource, giving real contribution to the community, and we'd love to see your ideas and contributions too!