Metadata-Version: 2.4
Name: qubex
Version: 1.5.0rc4
Summary: Qubex: Qubit experiment framework
Author: Akinori Machino
License-Expression: Apache-2.0
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anywidget>=0.9
Requires-Dist: cma>=4.0
Requires-Dist: cvxpy>=1.6
Requires-Dist: jsonpickle>=3.0
Requires-Dist: ipykernel>=6.0
Requires-Dist: ipywidgets>=7.7
Requires-Dist: kaleido==0.2.1
Requires-Dist: networkx>=2.7
Requires-Dist: nbformat>=5.0
Requires-Dist: numpy>=1.22
Requires-Dist: plotly<6,>=5.23
Requires-Dist: pydantic>=2.0
Requires-Dist: pyserial>=3.5
Requires-Dist: pyyaml>=6.0
Requires-Dist: qctrl-visualizer>=8.0
Requires-Dist: qubex-core==1.5.0rc4
Requires-Dist: qubex-pulse==1.5.0rc4
Requires-Dist: qubex-schema==1.5.0rc4
Requires-Dist: qubex-simulator==1.5.0rc4
Requires-Dist: qubex-visualizer==1.5.0rc4
Requires-Dist: rich>=13.0
Requires-Dist: scikit-learn>=1.0
Requires-Dist: scipy>=1.0
Requires-Dist: tqdm>=4.27.0
Requires-Dist: typedunits>=0.0
Requires-Dist: typing_extensions>=4.5
Provides-Extra: backend
Requires-Dist: qubex-driver-quel1==1.5.0rc4; extra == "backend"
Provides-Extra: quel1
Requires-Dist: qubex-driver-quel1==1.5.0rc4; extra == "quel1"
Provides-Extra: quel3
Requires-Dist: quelware-client>=0.6.1; extra == "quel3"
Requires-Dist: quelware-core>=0.7.0; extra == "quel3"
Dynamic: license-file

# Qubex: Qubit experiment framework

[![GitHub license](https://img.shields.io/github/license/amachino/qubex)](https://github.com/amachino/qubex/blob/main/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/amachino/qubex)](https://github.com/amachino/qubex/stargazers)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/amachino/qubex)

**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](https://amachino.github.io/qubex/user-guide/experiment/).
- **Simulator**: For researchers who want to study pulse-level Hamiltonian dynamics without using real hardware. See the [Simulator guide](https://amachino.github.io/qubex/user-guide/simulator/).
- **Pulse sequences**: Learn the shared `PulseSchedule` model used across hardware and simulation workflows. See the [PulseSchedule guide](https://amachino.github.io/qubex/user-guide/pulse-sequences/).
- **Low-level APIs**: Start here when you need measurement-side abstractions such as sessions, schedules, readout, sweeps, and backend integration. See the [overview](https://amachino.github.io/qubex/user-guide/low-level-apis/).

## Requirements

- Python 3.10 or higher

## Installation

The `1.5.0rc4` release candidate can be installed from PyPI:

```bash
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/](https://docs.astral.sh/uv/getting-started/installation/)

### Install latest release

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

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

```bash
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

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

### Install specific version

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

Check available versions on the [Release Page](https://github.com/amachino/qubex/releases).

### Install for development

Development in this repository assumes a `uv`-managed environment.

```bash
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/](https://amachino.github.io/qubex/).

- User guides: [Installation](https://amachino.github.io/qubex/user-guide/getting-started/installation/), [System configuration](https://amachino.github.io/qubex/user-guide/getting-started/system-configuration/), [Choose where to start](https://amachino.github.io/qubex/user-guide/getting-started/choose-where-to-start/), [Examples](https://amachino.github.io/qubex/examples/), and [API reference](https://amachino.github.io/qubex/api-reference/qubex/).
- Contributors: [Contributing](https://amachino.github.io/qubex/CONTRIBUTING/), [Developer guide](https://amachino.github.io/qubex/developer-guide/), and the source files in [docs](https://github.com/amachino/qubex/tree/main/docs).
