Skip to content

Installation

Qubex runs on Python 3.10+. When you are not using hardware backends, it is not tied to a specific operating system. Hardware backends require additional dependencies and typically assume a Linux host. 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 backend support for real hardware use (Linux)

Use this variant when you plan to use Qubex with real hardware on a Linux host. If you only want to use QuantumSimulator, you do not need the backend or quel1 extra.

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

This installs the public QuEL-1 backend libraries required for hardware-backed execution. qubex[quel1] is available as the equivalent explicit extra.

Install with QuEL-3 support

Use this variant when you plan to use Qubex with QuEL-3 runtime support.

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

quel3 depends on quelware-client. If that package is not published on PyPI, install it from the package source or index specified by your environment.

Install specific version

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

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

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