qosst-bob 0.10.2

Bob submodule of QOSST, containing modules for Bob client, the GUI, the DSP of Bob and parameters estimation.

qosst-bob

---

This project is part of QOSST.

Features

qosst-bob is the module of QOSST in charge of the functionalities of Bob for CV-QKD. In particular it includes:

• Acquisition of the signal detected by Bob's detector;
• Digital Signal Processing of the acquired signal to recover the symbols sent by Alice;
• Correlations analysis to estimate the parameters of the channel;
• Bob's client to interact with Alice's server;
• Interfaces to this client (scripts and graphical interface).

Installation

The module can be installed with the following command:

pip install qosst-bob

It is also possible to install it directly from the github repository:

pip install git+https://github.com/qosst/qosst-bob

It also possible to clone the repository before and install it with pip or poetry

git clone https://github.com/qosst/qosst-bob
cd qosst-alice
poetry install
pip install .

Documentation

The whole documentation can be found at https://qosst-bob.readthedocs.io/en/latest/

Usage of the client

The client can either be used with the graphical interface, with one of the provided script (optimize, excess noise or transmittance) or in a home-made script.

In any case the first step is to create a configuration file. This can be done with a command line tool shipped with the qosst-core package (which is a dependency of qosst-alice):

qosst configuration create

This will create the default configuration file at the location config.toml (you change the location with the -f or --file option). For more information on the meaning of each parameter in the configuration and how to change them, check the qosst tutorial.

GUI usage

The GUI can be launched with the following command:

qosst-bob-gui

A tutorial on the GUI can be found in the documentation.

Scripts usage

The command line of the three scripts are given below:

qosst-bob-excess-noise
qosst-bob-optimize
qosst-bob-transmittance

A good start is to add the -h flag to get information on the command line options. An extensive documentation is also written in the CLI section of the documentation.

Usage in home-made scripts

It's possible to import Bob's client:

from qosst_bob.bob import Bob

and use it in home-made script. Please refer to the documentation for more details.

License

As for all submodules of QOSST, qosst-bob is shipped under the Gnu General Public License v3.

Contributing

Contribution are more than welcomed, either by reporting issues or proposing merge requests. Please check the contributing section of the QOSST project fore more information.