Installation instructions

Qibosoq is fully compatible with Python >=3.8, <3.12.

Installing with pip

This is the raccomended approach in order to install Qibosoq.

pip install qibosoq

Warning

For running qibosoq on board, sudo privileges are required, so the installation must be done with:

sudo -i python -m pip install qibosoq

Installing from source

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

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

Now the installation can be done in normal mode or in developer mode (using poetry):

pip install .  # normal mode
poetry install  # developer mode

Warning

For running qibosoq on board, sudo privileges are required, so the installation must be done with:

sudo -E python -m pip install <path_to_qibosoq>  # normal mode
sudo -E python -m poetry install <path_to_qibosoq> # developer mode

Finally, on boards running with Python 3.8 the standard installation method for developer mode does not work, since it requires a version of Poetry not supported. In this case, it is mandatory to pass through the provided legacy installation script via sudo:

sudo <path_to_qibosoq>/qibosoq/dev-install.bash

And to uninstall it:

sudo <path_to_qibosoq>/qibosoq/dev-uninstall.bash