| Name | qosst-alice JSON |
| Version |
0.10.0
JSON |
| download |
| home_page | https://github.com/qosst |
| Summary | Alice submodule of QOSST, containing the server and DSP of Alice. |
| upload_time | 2024-04-29 12:40:27 |
| 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-alice
<center>
</center>
This project is part of [QOSST](https://github.com/qosst/qosst).
## Features
`qosst-alice` is the module of QOSST in charge of the functionalities of Alice for CV-QKD. In particular it includes:
* Generation of symbols according to a given constellation of points with an associated distribution;
* Digital Signal Processing of those symbols to generate a sequence to apply on a modulator;
* Interface to apply the sequence to the hardware;
* Estimation of Alice's parameters (in particular the average number of photons per symbols);
* Alice's server code.
## Installation
The module can be installed with the following command:
```console
pip install qosst-alice
```
It is also possible to install it directly from the github repository:
```console
pip install git+https://github.com/qosst/qosst-alice
```
It also possible to clone the repository before and install it with pip or poetry
```console
git clone https://github.com/qosst/qosst-alice
cd qosst-alice
poetry install
pip install .
```
## Documentation
The whole documentation can be found at https://qosst-alice.readthedocs.io/en/latest/
## Command line usage
A command line is shipped with the project to be able to launch Alice's server. 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).
Alice's server can then be launched with the following command:
```console
qosst-alice -f config.toml
```
## License
As for all submodules of QOSST, `qosst-alice` 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-alice",
"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/39/fd/e4e6d9e9a13b877b0764faafa10c6b7a7d2b05441d3a74bb3f90e53fdfce/qosst_alice-0.10.0.tar.gz",
"platform": null,
"description": "# qosst-alice\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-alice` is the module of QOSST in charge of the functionalities of Alice for CV-QKD. In particular it includes:\n\n* Generation of symbols according to a given constellation of points with an associated distribution;\n* Digital Signal Processing of those symbols to generate a sequence to apply on a modulator;\n* Interface to apply the sequence to the hardware;\n* Estimation of Alice's parameters (in particular the average number of photons per symbols);\n* Alice's server code.\n\n## Installation\n\nThe module can be installed with the following command: \n\n```console\npip install qosst-alice\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-alice\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-alice\ncd qosst-alice\npoetry install\npip install .\n```\n\n## Documentation\n\nThe whole documentation can be found at https://qosst-alice.readthedocs.io/en/latest/\n\n## Command line usage\n\nA command line is shipped with the project to be able to launch Alice's server. 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\nAlice's server can then be launched with the following command: \n\n```console\nqosst-alice -f config.toml\n```\n\n## License\n\nAs for all submodules of QOSST, `qosst-alice` 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.",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Alice submodule of QOSST, containing the server and DSP of Alice.",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://qosst-alice.readthedocs.io/",
"Homepage": "https://github.com/qosst",
"Repository": "https://github.com/qosst/qosst-alice"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a12b5651d16f568bf844b7495ea3a99b4e2f938e968f0ba67ae1b332813eebb",
"md5": "7f1d30513bec8230f9e7453584616b1d",
"sha256": "9c41cb8e3305adf430051baa3016eed3fdc01731a30e1bee39a9c198a8306561"
},
"downloads": -1,
"filename": "qosst_alice-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f1d30513bec8230f9e7453584616b1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 35103,
"upload_time": "2024-04-29T12:40:25",
"upload_time_iso_8601": "2024-04-29T12:40:25.618421Z",
"url": "https://files.pythonhosted.org/packages/0a/12/b5651d16f568bf844b7495ea3a99b4e2f938e968f0ba67ae1b332813eebb/qosst_alice-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39fde4e6d9e9a13b877b0764faafa10c6b7a7d2b05441d3a74bb3f90e53fdfce",
"md5": "cc030b56f1e413d982985011d2569b40",
"sha256": "4a7d09b8c632ca0311180f5da81021df162ed5b2a019210fb9a23b95eaeaeb46"
},
"downloads": -1,
"filename": "qosst_alice-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "cc030b56f1e413d982985011d2569b40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 31091,
"upload_time": "2024-04-29T12:40:27",
"upload_time_iso_8601": "2024-04-29T12:40:27.714887Z",
"url": "https://files.pythonhosted.org/packages/39/fd/e4e6d9e9a13b877b0764faafa10c6b7a7d2b05441d3a74bb3f90e53fdfce/qosst_alice-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 12:40:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qosst",
"github_project": "qosst-alice",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qosst-alice"
}
