Getting started

Hardware requirements

Operating System

The QOSST suite does not required a particular software and should work on Windows (tested), Linux (tested) and Mac (not tested).

The actual operating system requirement will come down to the hardware used for the experiment since some of them don’t have interfaces with Windows.

Python version

QOSST if officially supporting any python version 3.9 or above.

Installing the software

There are several ways of installing the software, either by using the PyPi repositories or using the source.

Installing the required software for Bob

To install the required software for Bob you can simply run the command

pip install qosst-bob

This will automatically install qosst-bob (along with other required dependencies).

Alternatively, you can clone the repository at https://github.com/qosst/qosst-bob and install it by source.

Checking the version of the software

qosst-core will be automatically installed as it is a dependency of qosst-bob provides the qosst command from which the whole documentation can be found .

You can check the version by issuing the command

$ qosst info


 ██████╗  ██████╗ ███████╗███████╗████████╗
██╔═══██╗██╔═══██╗██╔════╝██╔════╝╚══██╔══╝
██║   ██║██║   ██║███████╗███████╗   ██║   
██║▄▄ ██║██║   ██║╚════██║╚════██║   ██║   
╚██████╔╝╚██████╔╝███████║███████║   ██║   
 ╚══▀▀═╝  ╚═════╝ ╚══════╝╚══════╝   ╚═╝  
                                                                                                                                         
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
python version: 3.11.6 (main, Feb  1 2024, 16:47:41) [GCC 11.4.0]

QOSST versions
qosst_core: 0.10.0
qosst_hal: 0.10.0
qosst_alice: Not installed
qosst_bob: 0.10.0
qosst_skr: 0.10.0
qosst_pp: Not installed

If the qosst command was not installed in the path, it also possible to run the following command:

python3 -m qosst_core.commands info

or

python3 -c "from qosst_core.infos import get_script_infos; print(get_script_infos())"

In the following we will assume that you have access to the qosst (and other) commands. If not you can replace the instructions similarly to above.

If this works and have the newest versions, you should be ready to go !