| Name | qosst-bob JSON |
| Version |
0.10.0
JSON |
| download |
| home_page | https://github.com/qosst |
| Summary | Bob submodule of QOSST, containing modules for Bob client, the GUI, the DSP of Bob and parameters estimation. |
| upload_time | 2024-04-29 12:48:36 |
| maintainer | None |
| docs_url | None |
| author | Yoann Piétri |
| requires_python | <3.13,>=3.9 |
| license | GPLv3 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# qosst-bob
<center>
</center>
This project is part of [QOSST](https://github.com/qosst/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:
```console
pip install qosst-bob
```
It is also possible to install it directly from the github repository:
```console
pip install git+https://github.com/qosst/qosst-bob
```
It also possible to clone the repository before and install it with pip or poetry
```console
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`):
```console
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](https://qosst.readthedocs.io/en/latest/tutorial.html).
### GUI usage
The GUI can be launched with the following command:
```console
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:
```console
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:
```python
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](https://www.gnu.org/licenses/gpl-3.0.html).
## Contributing
Contribution are more than welcomed, either by reporting issues or proposing merge requests. Please check the contributing section of the [QOSST](https://github.com/qosst/qosst) project fore more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/qosst",
"name": "qosst-bob",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Yoann Pi\u00e9tri",
"author_email": "Yoann.Pietri@lip6.fr",
"download_url": "https://files.pythonhosted.org/packages/4a/46/74d33c752de44beb84e237772369365ca320153454fef674c9efca36bd2f/qosst_bob-0.10.0.tar.gz",
"platform": null,
"description": "# qosst-bob\n\n<center>\n\n\n\n</center>\n\nThis project is part of [QOSST](https://github.com/qosst/qosst).\n\n## Features\n\n`qosst-bob` is the module of QOSST in charge of the functionalities of Bob for CV-QKD. In particular it includes:\n\n* Acquisition of the signal detected by Bob's detector;\n* Digital Signal Processing of the acquired signal to recover the symbols sent by Alice;\n* Correlations analysis to estimate the parameters of the channel;\n* Bob's client to interact with Alice's server;\n* Interfaces to this client (scripts and graphical interface).\n\n## Installation\n\nThe module can be installed with the following command:\n\n```console\npip install qosst-bob\n```\n\nIt is also possible to install it directly from the github repository:\n\n```console\npip install git+https://github.com/qosst/qosst-bob\n```\n\nIt also possible to clone the repository before and install it with pip or poetry\n\n```console\ngit clone https://github.com/qosst/qosst-bob\ncd qosst-alice\npoetry install\npip install .\n```\n\n## Documentation\n\nThe whole documentation can be found at https://qosst-bob.readthedocs.io/en/latest/\n\n## Usage of the client\n\nThe 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.\n\nIn 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`):\n\n```console\nqosst configuration create\n```\n\nThis 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](https://qosst.readthedocs.io/en/latest/tutorial.html).\n\n### GUI usage\n\nThe GUI can be launched with the following command:\n\n```console\nqosst-bob-gui\n```\n\nA tutorial on the GUI can be found in the documentation.\n\n### Scripts usage\n\nThe command line of the three scripts are given below:\n\n```console\nqosst-bob-excess-noise\nqosst-bob-optimize\nqosst-bob-transmittance\n```\n\nA 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.\n\n### Usage in home-made scripts\n\nIt's possible to import Bob's client:\n\n```python\nfrom qosst_bob.bob import Bob\n```\n\nand use it in home-made script. Please refer to the documentation for more details.\n\n## License\n\nAs for all submodules of QOSST, `qosst-bob` is shipped under the [Gnu General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).\n\n## Contributing\n\nContribution are more than welcomed, either by reporting issues or proposing merge requests. Please check the contributing section of the [QOSST](https://github.com/qosst/qosst) project fore more information.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Bob submodule of QOSST, containing modules for Bob client, the GUI, the DSP of Bob and parameters estimation.",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://qosst-bob.readthedocs.io/",
"Homepage": "https://github.com/qosst",
"Repository": "https://github.com/qosst/qosst-bob"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80a2d8b099be7687adceaea1fbf01f067f8297f43b75eb2d92b1fd1d5238d2c8",
"md5": "a151958373e880298bca6ce74ef14aad",
"sha256": "4d2b7dd94bdb6b2ae3f9082f2cd3e96740e4715124a363fb9ad6d1ebdddcac30"
},
"downloads": -1,
"filename": "qosst_bob-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a151958373e880298bca6ce74ef14aad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 162949,
"upload_time": "2024-04-29T12:48:33",
"upload_time_iso_8601": "2024-04-29T12:48:33.722622Z",
"url": "https://files.pythonhosted.org/packages/80/a2/d8b099be7687adceaea1fbf01f067f8297f43b75eb2d92b1fd1d5238d2c8/qosst_bob-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a4674d33c752de44beb84e237772369365ca320153454fef674c9efca36bd2f",
"md5": "bf87433ec3420a5d5a2f89ad2286d7e5",
"sha256": "8ff004bf6a7f31fef48cc6fc47a3aef30fec663be6d0c54aedd007e9868372a5"
},
"downloads": -1,
"filename": "qosst_bob-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "bf87433ec3420a5d5a2f89ad2286d7e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 133892,
"upload_time": "2024-04-29T12:48:36",
"upload_time_iso_8601": "2024-04-29T12:48:36.190594Z",
"url": "https://files.pythonhosted.org/packages/4a/46/74d33c752de44beb84e237772369365ca320153454fef674c9efca36bd2f/qosst_bob-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 12:48:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qosst",
"github_project": "qosst-bob",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qosst-bob"
}
