Skip to content

Installation

Qubex runs on Python 3.10+. Only QuEL-1 support requires Linux. During the v1.5.0 beta period and until the official release, installing Qubex requires uv. We plan to publish Qubex to PyPI for the official release, which will make pip install available.

Prepare Python environment

We recommend using uv to manage Python and virtual environments. uv is a unified tool for installing Python, creating virtual environments, and managing dependencies.

Create virtual environment

It is best practice to install Qubex in a dedicated virtual environment to prevent conflicts with system packages or other projects.

Run one of the following commands in your project directory.

uv venv

python -m venv .venv
source .venv/bin/activate

Install Qubex

This section introduces installation options for standard use, backend-enabled setups, pinned versions, and development workflows.

Install latest version

Use this option when you want the newest Qubex features from the repository.

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

Install with QuEL-1 and QuEL-3 support (Linux only)

Use backend to install the dependencies for both QuEL-1 and QuEL-3.

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

Hardware extras are unnecessary for simulator-only use.

Install with QuEL-1 support only (Linux only)

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

Install with QuEL-3 support only

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

Install specific version

Use this option when you need a pinned version for reproducibility.

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

To include hardware dependencies, replace qubex in the example above with qubex[backend], qubex[quel1], or qubex[quel3].

Install for development

Use this setup to prepare a local environment for developing and testing Qubex. Development commands in this repository assume a uv-managed environment.

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

Next steps