Qubex: Qubit experiment framework

Qubex is a Python library designed to simplify and accelerate quantum experiments by providing a flexible and extensible framework for pulse-level control, readout, and calibration on quantum hardware. It streamlines experiment workflows such as:

• Qubit and resonator spectroscopy
• T1 and T2 measurement
• Single- and two-qubit gate calibration
• Randomized Benchmarking
• Pulse-level experiments and simulations

Recommended docs paths

• Experiment: The recommended user-facing workflow for most hardware-backed qubit experiments, from setup through analysis. See the Experiment guide.
• Simulator: For researchers who want to study pulse-level Hamiltonian dynamics without using real hardware. See the Simulator guide.
• Pulse sequences: Learn the shared PulseSchedule model used across hardware and simulation workflows. See the PulseSchedule guide.
• Low-level APIs: Start here when you need measurement-side abstractions such as sessions, schedules, readout, sweeps, and backend integration. See the overview.

Requirements

• Python 3.10 or higher

Installation

The 1.5.0rc4 release candidate can be installed from PyPI:

pip install "qubex==1.5.0rc4"

For hardware support, install qubex[backend]==1.5.0rc4 (QuEL-1, Linux) or qubex[quel3]==1.5.0rc4. This is a prerelease for validation before v1.5.0. The Git-based commands below install the repository version. To install uv, see the official guide: https://docs.astral.sh/uv/getting-started/installation/

Install latest release

uv pip install git+https://github.com/amachino/qubex.git

Install with QuEL-1 backend support for real hardware use (Linux only)

uv pip install "qubex[backend] @ git+https://github.com/amachino/qubex.git"

backend is the public extra for QuEL-1 support. quel1 is available as the equivalent explicit extra name. If you only want to use the simulator, you do not need either extra.

Install with QuEL-3 support

uv pip install "qubex[quel3] @ git+https://github.com/amachino/qubex.git"

Install specific version

uv pip install "git+https://github.com/amachino/qubex.git@<version>"

Check available versions on the Release Page.

Install for development

Development in this repository assumes a uv-managed environment.

git clone -b develop https://github.com/amachino/qubex.git
cd qubex
make sync

Documentation

The documentation is available at https://amachino.github.io/qubex/.

• User guides: Installation, System configuration, Choose where to start, Examples, and API reference.
• Contributors: Contributing, Developer guide, and the source files in docs.