| Name | qosst JSON |
| Version |
0.10.0
JSON |
| download |
| home_page | https://github.com/qosst |
| Summary | Quantum Open Source Software for Secure Transmission (QOSST) is a suite of software to implement a CV-QKD system. |
| upload_time | 2024-04-29 12:54:59 |
| 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 - Quantum Open Software for Secure Transmissions
<center>
</center>
This repo serves two purposes: the first is to explain how the code quality of QOSST and the second one is to give a general introduction to QOSST.
QOSST was initially developed in the [Quantum Information (QI) team](https://qi.lip6.fr) of the [LIP6 laboratory](https://lip6.fr) in Sorbonne Université.
## Article
The link to the article will be added soon.
## Structure
The QOSST software is separated in 7 submodules:
* `qosst-core` for the configuration, control protocol, and common functions to Alice and Bob;
* `qosst-alice` for the digital signal processing (DSP), server, and interaction with the hardware for Alice;
* `qosst-bob` for the digital signal processing (DSP), client, interaction with the hardware, parameters estimation for Bob.;
* `qosst-hal` for hardware abstraction layer;
* `qosst-skr` for the secret key rate computations;
* `qosst-sim` for the simulations;
* `qosst-pp` for the post processing.
To operate Alice, it is only necessary to install the `qosst-alice` package. The other packages that are required will be automatically installed. The same applies for `qosst-bob`.
## Links and documentation
| Name | URL | Documentation |
| ------------- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `qosst-core` | [https://github.com/qosst/qosst-core](https://github.com/qosst/qosst-core) | [https://qosst-core.readthedocs.io/](https://qosst-core.readthedocs.io/) |
| `qosst-hal` | [https://github.com/qosst/qosst-hal](https://github.com/qosst/qosst-hal) | [https://qosst-hal.readthedocs.io/](https://qosst-hal.readthedocs.io/) |
| `qosst-alice` | [https://github.com/qosst/qosst-alice](https://github.com/qosst/qosst-alice) | [https://qosst-alice.readthedocs.io/](https://qosst-alice.readthedocs.io/) |
| `qosst-bob` | [https://github.com/qosst/qosst-bob](https://github.com/qosst/qosst-bob) | [https://qosst-bob.readthedocs.io/](https://qosst-bob.readthedocs.io/) |
| `qosst-skr` | [https://github.com/qosst/qosst-skr](https://github.com/qosst/qosst-skr) | [https://qosst-skr.readthedocs.io/](https://qosst-skr.readthedocs.io/) |
| `qosst-sim` | [https://github.com/qosst/qosst-sim](https://github.com/qosst/qosst-sim) | [https://qosst-sim.readthedocs.io/](https://qosst-sim.readthedocs.io/) |
| `qosst-pp` | Not released | Not released. |
## Code quality
The code quality of the QOSST submodules are checked via three tools:
* [pylint](https://pypi.org/project/pylint/) for the static linting;
* [mypy](https://mypy-lang.org/) for the type hints checking;
* [docstr-coverage](https://pypi.org/project/docstr-coverage/) for checking the coverage of documentation.
The script `code_quality.py` automatically applies all the checks to all the submodules.
Additionally, the QOSST submodules are formatted with [black](https://github.com/psf/black).
## License
The submodules of QOSST are shipped under the [Gnu General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).
## Contributing
### Report issues
Reporting issues is the first way to contribute to the software.
You can report global issue with the software on the issues tracker of QOSST at [https://github.com/qosst/qosst/issues](https://github.com/qosst/qosst/issues).
It is however preferable to use the specialized repo for issues that are specific to a module:
| Module | URL of the issues tracker |
| ------------- | ------------------------------------------------------------------------------------------ |
| `qosst-core` | [https://github.com/qosst/qosst-core/issues](https://github.com/qosst/qosst-core/issues) |
| `qosst-hal` | [https://github.com/qosst/qosst-hal/issues](https://github.com/qosst/qosst-hal/issues) |
| `qosst-alice` | [https://github.com/qosst/qosst-alice/issues](https://github.com/qosst/qosst-alice/issues) |
| `qosst-bob` | [https://github.com/qosst/qosst-bob/issues](https://github.com/qosst/qosst-bob/issues) |
| `qosst-skr` | [https://github.com/qosst/qosst-skr/issues](https://github.com/qosst/qosst-skr/issues) |
| `qosst-sim` | [https://github.com/qosst/qosst-sim/issues](https://github.com/qosst/qosst-sim/issues) |
Please include the following information when reporting a bug
* description of the bug;
* versions of the QOSST software;
* configuration file;
* used hardware, if relevant;
* logs of the error.
When requesting new feature, please provide a detailed description of what you propose and any reference that could be relevant.
### Proposing code
You can propose code, either to solve issues or to propose new features directly.
If you want to solve an issue please comment on the issue on the issue tracker so we can assign the assign to you.
Here are the steps you should do:
1. Fork the repository on your github account;
2. Clone your forked repository;
3. Make the changes and commit;
4. Push to your forked repository;
5. Open a Pull Request on the associated repository.
We will then check the changes and merge when it's ready.
## Acknowledgments
We first thank the direct contributors of the code:
* Yoann Piétri
* Valentina Marulanda Acosta
* Matteo Schiavon
* Mayeul Chavanne
* Ilektra Karakosta - Amarantidou
We also thank all the persons that made comments and discussions that had a direct impact on this software:
* Luis-Trigo Vidarte
* Baptiste Gouraud
* Amine Rhouni
* Eleni Diamanti
* Philippe Grangier
And finally we thank the persons that participated in some ways to the development of QOSST:
* Thomas Liege
* George Crisan
* Damien Fruleux
* Sarah Layani
* Manon Huguenot
Raw data
{
"_id": null,
"home_page": "https://github.com/qosst",
"name": "qosst",
"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/1f/3f/61de6d52c1d9199df149919b29770633f6baace811367facbe6901757bdd/qosst-0.10.0.tar.gz",
"platform": null,
"description": "# QOSST - Quantum Open Software for Secure Transmissions\n\n<center>\n\n\n\n</center>\n\nThis repo serves two purposes: the first is to explain how the code quality of QOSST and the second one is to give a general introduction to QOSST.\n\nQOSST was initially developed in the [Quantum Information (QI) team](https://qi.lip6.fr) of the [LIP6 laboratory](https://lip6.fr) in Sorbonne Universit\u00e9.\n\n## Article\n\nThe link to the article will be added soon.\n\n## Structure\n\nThe QOSST software is separated in 7 submodules:\n\n* `qosst-core` for the configuration, control protocol, and common functions to Alice and Bob;\n* `qosst-alice` for the digital signal processing (DSP), server, and interaction with the hardware for Alice;\n* `qosst-bob` for the digital signal processing (DSP), client, interaction with the hardware, parameters estimation for Bob.;\n* `qosst-hal` for hardware abstraction layer;\n* `qosst-skr` for the secret key rate computations;\n* `qosst-sim` for the simulations;\n* `qosst-pp` for the post processing.\n\nTo operate Alice, it is only necessary to install the `qosst-alice` package. The other packages that are required will be automatically installed. The same applies for `qosst-bob`.\n\n## Links and documentation\n\n| Name | URL | Documentation |\n| ------------- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- |\n| `qosst-core` | [https://github.com/qosst/qosst-core](https://github.com/qosst/qosst-core) | [https://qosst-core.readthedocs.io/](https://qosst-core.readthedocs.io/) |\n| `qosst-hal` | [https://github.com/qosst/qosst-hal](https://github.com/qosst/qosst-hal) | [https://qosst-hal.readthedocs.io/](https://qosst-hal.readthedocs.io/) |\n| `qosst-alice` | [https://github.com/qosst/qosst-alice](https://github.com/qosst/qosst-alice) | [https://qosst-alice.readthedocs.io/](https://qosst-alice.readthedocs.io/) |\n| `qosst-bob` | [https://github.com/qosst/qosst-bob](https://github.com/qosst/qosst-bob) | [https://qosst-bob.readthedocs.io/](https://qosst-bob.readthedocs.io/) |\n| `qosst-skr` | [https://github.com/qosst/qosst-skr](https://github.com/qosst/qosst-skr) | [https://qosst-skr.readthedocs.io/](https://qosst-skr.readthedocs.io/) |\n| `qosst-sim` | [https://github.com/qosst/qosst-sim](https://github.com/qosst/qosst-sim) | [https://qosst-sim.readthedocs.io/](https://qosst-sim.readthedocs.io/) |\n| `qosst-pp` | Not released | Not released. |\n\n## Code quality\n\nThe code quality of the QOSST submodules are checked via three tools:\n\n* [pylint](https://pypi.org/project/pylint/) for the static linting;\n* [mypy](https://mypy-lang.org/) for the type hints checking;\n* [docstr-coverage](https://pypi.org/project/docstr-coverage/) for checking the coverage of documentation.\n\nThe script `code_quality.py` automatically applies all the checks to all the submodules.\n\nAdditionally, the QOSST submodules are formatted with [black](https://github.com/psf/black).\n\n## License\n\nThe submodules of QOSST are shipped under the [Gnu General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).\n\n## Contributing\n\n### Report issues\n\nReporting issues is the first way to contribute to the software.\n\nYou can report global issue with the software on the issues tracker of QOSST at [https://github.com/qosst/qosst/issues](https://github.com/qosst/qosst/issues).\n\nIt is however preferable to use the specialized repo for issues that are specific to a module:\n\n| Module | URL of the issues tracker |\n| ------------- | ------------------------------------------------------------------------------------------ |\n| `qosst-core` | [https://github.com/qosst/qosst-core/issues](https://github.com/qosst/qosst-core/issues) |\n| `qosst-hal` | [https://github.com/qosst/qosst-hal/issues](https://github.com/qosst/qosst-hal/issues) |\n| `qosst-alice` | [https://github.com/qosst/qosst-alice/issues](https://github.com/qosst/qosst-alice/issues) |\n| `qosst-bob` | [https://github.com/qosst/qosst-bob/issues](https://github.com/qosst/qosst-bob/issues) |\n| `qosst-skr` | [https://github.com/qosst/qosst-skr/issues](https://github.com/qosst/qosst-skr/issues) |\n| `qosst-sim` | [https://github.com/qosst/qosst-sim/issues](https://github.com/qosst/qosst-sim/issues) |\n\nPlease include the following information when reporting a bug\n\n* description of the bug;\n* versions of the QOSST software;\n* configuration file;\n* used hardware, if relevant;\n* logs of the error.\n\nWhen requesting new feature, please provide a detailed description of what you propose and any reference that could be relevant.\n\n### Proposing code\n\nYou can propose code, either to solve issues or to propose new features directly.\n\nIf you want to solve an issue please comment on the issue on the issue tracker so we can assign the assign to you.\n\nHere are the steps you should do:\n\n1. Fork the repository on your github account;\n2. Clone your forked repository;\n3. Make the changes and commit;\n4. Push to your forked repository;\n5. Open a Pull Request on the associated repository.\n\nWe will then check the changes and merge when it's ready.\n\n## Acknowledgments\n\nWe first thank the direct contributors of the code:\n* Yoann Pi\u00e9tri\n* Valentina Marulanda Acosta\n* Matteo Schiavon\n* Mayeul Chavanne\n* Ilektra Karakosta - Amarantidou\n\nWe also thank all the persons that made comments and discussions that had a direct impact on this software:\n* Luis-Trigo Vidarte\n* Baptiste Gouraud\n* Amine Rhouni\n* Eleni Diamanti\n* Philippe Grangier\n\nAnd finally we thank the persons that participated in some ways to the development of QOSST:\n* Thomas Liege\n* George Crisan\n* Damien Fruleux\n* Sarah Layani\n* Manon Huguenot\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Quantum Open Source Software for Secure Transmission (QOSST) is a suite of software to implement a CV-QKD system.",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://qosst.readthedocs.io/",
"Homepage": "https://github.com/qosst",
"Repository": "https://github.com/qosst/qosst"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73c0730eb5606cc1c28ba9139e025cd5279016928287a934eb4cdf8ba7a4d427",
"md5": "55c86b84276c7fcf49baa33a7c3ed2a4",
"sha256": "06849c585cc84adc69f5016227a2ebb428583bc298ddece0356d4a4a6cf7355b"
},
"downloads": -1,
"filename": "qosst-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55c86b84276c7fcf49baa33a7c3ed2a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 4688,
"upload_time": "2024-04-29T12:54:56",
"upload_time_iso_8601": "2024-04-29T12:54:56.820071Z",
"url": "https://files.pythonhosted.org/packages/73/c0/730eb5606cc1c28ba9139e025cd5279016928287a934eb4cdf8ba7a4d427/qosst-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f3f61de6d52c1d9199df149919b29770633f6baace811367facbe6901757bdd",
"md5": "526501f7cdc6214e7c1db9e6c2079c0f",
"sha256": "2f64ac002a84d27afeea98d6334bbb2085c3ede335f4db07d83b109d54b2f9c9"
},
"downloads": -1,
"filename": "qosst-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "526501f7cdc6214e7c1db9e6c2079c0f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 4229,
"upload_time": "2024-04-29T12:54:59",
"upload_time_iso_8601": "2024-04-29T12:54:59.100829Z",
"url": "https://files.pythonhosted.org/packages/1f/3f/61de6d52c1d9199df149919b29770633f6baace811367facbe6901757bdd/qosst-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 12:54:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qosst",
"github_project": "qosst",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qosst"
}
