Installation instructions#

Qibolab#

Installing with pip#

The installation using pip is the recommended approach to use Qibolab. After updating pip, if needed, install Qibolab with:

pip install qibolab

Note

Remember that Qibolab is compatible with Pyhon >= 3.9 and < 3.12.

Installing with conda#

We provide conda packages for qibolab through the conda-forge channel.

To install the package with conda run:

conda install -c conda-forge qibolab

Installing from source#

It is possible to install Qibolab from source, althought it is not recommended if not strictly required.

In order to install qibolab from source, you have to clone the GitHub repository with:

git clone https://github.com/qiboteam/qibolab.git
cd qibolab

Then, to install the package in standard mode (recommended if no changes on the source code are needed) one can still use pip:

pip install . # or pip install -e .

For developers, in order to modify the source code, it is possible to install using poetry or pip:

poetry install    # recommended
pip install -e .  # not recommended

Supported instruments#

../_images/qibolab_instruments.svg

Qibolab supports the following control instruments:

  • Quantum Machines

  • Zurich Instruments

  • QBlox

  • Xilinx RFSoCs

In order to use Qibolab on with one of these instruments chosen instrument, additional dependencies need to be installed. This can be done with:

# for installation from releases
pip install qibolab[qm,zh,qblox,rfsoc]

# or for installation from source
poetry install -E qm -E zh -E qblox -E rfsoc

Or with conda

conda install -c conda-forge qibolab[qm,zh,qblox,rfsoc]

With the extras being:

  • Quantum Machines -> qm

  • Zurich Instruments -> zh

  • QBlox -> qblox

  • Xilinx RFSoCs -> rfsoc

Note

Installing all the extras is usually not needed. It is possible to install qibolab with any number of extras.