Name | qosst-core JSON |
Version |
0.10.0
JSON |
| download |
home_page | https://github.com/qosst |
Summary | Core submodule of QOSST, containing modules for configuration, control protocol, authentication, modulation and communication filters. |
upload_time | 2024-04-29 12:38:01 |
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-core
<center>
![QOSST Logo](qosst_logo_full.png)
</center>
This project is part of [QOSST](https://github.com/qosst/qosst).
## Features
`qosst-core` is the module of QOSST in charge of the common functionalities of Alice and Bob for CV-QKD. In particular it includes:
* Configuration file and reader;
* Authentication;
* Classical communication protocol;
* Modulations;
* Filters and synchronisation sequence for digital signal processing;
* And some utils functions and constant definitions.
## Installation
The module can be installed with the following command:
```console
pip install qosst-core
```
It is also possible to install it directly from the github repository:
```console
pip install git+https://github.com/qosst/qosst-core
```
It also possible to clone the repository before and install it with pip or poetry
```console
git clone https://github.com/qosst/qosst-core
cd qosst-alice
poetry install
pip install .
```
## Documentation
The whole documentation can be found at https://qosst-core.readthedocs.io/en/latest/
## Usage
`qosst-core` will rarely be used as a standalone package. It is worth noting however that there is a command line tool shipped with the `qosst-core` package that has general commands but also the command for authentication initialization and configuration create.
The command line is
```console
qosst
```
and more information on it can be found in the CLI section of the documentation.
## License
As for all submodules of QOSST, `qosst-core` 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-core",
"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/1d/5c/dea734678df5bc2698f50f6a2f0c97c52d4f8504586afcf2680233f6927a/qosst_core-0.10.0.tar.gz",
"platform": null,
"description": "# qosst-core\n\n<center>\n\n![QOSST Logo](qosst_logo_full.png)\n\n</center>\n\nThis project is part of [QOSST](https://github.com/qosst/qosst).\n\n## Features\n\n`qosst-core` is the module of QOSST in charge of the common functionalities of Alice and Bob for CV-QKD. In particular it includes:\n\n* Configuration file and reader;\n* Authentication;\n* Classical communication protocol;\n* Modulations;\n* Filters and synchronisation sequence for digital signal processing;\n* And some utils functions and constant definitions.\n\n## Installation\n\nThe module can be installed with the following command:\n\n```console\npip install qosst-core\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-core\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-core\ncd qosst-alice\npoetry install\npip install .\n```\n\n## Documentation\n\nThe whole documentation can be found at https://qosst-core.readthedocs.io/en/latest/\n\n## Usage\n\n`qosst-core` will rarely be used as a standalone package. It is worth noting however that there is a command line tool shipped with the `qosst-core` package that has general commands but also the command for authentication initialization and configuration create.\n\nThe command line is \n\n```console\nqosst\n```\n\n and more information on it can be found in the CLI section of the documentation.\n\n## License\n\nAs for all submodules of QOSST, `qosst-core` 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": "Core submodule of QOSST, containing modules for configuration, control protocol, authentication, modulation and communication filters.",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://qosst-core.readthedocs.io/",
"Homepage": "https://github.com/qosst",
"Repository": "https://github.com/qosst/qosst-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0485b942092564458ca6d3211c7daafc2a793daefe90bd0bf19c8652cea00c87",
"md5": "fb75961b022114cca9b0295bf5841f32",
"sha256": "7154bad16972f4da1b47d000c413b9d24a8c5f1a1801e4c9db8a81071803f64f"
},
"downloads": -1,
"filename": "qosst_core-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb75961b022114cca9b0295bf5841f32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 95972,
"upload_time": "2024-04-29T12:37:58",
"upload_time_iso_8601": "2024-04-29T12:37:58.717523Z",
"url": "https://files.pythonhosted.org/packages/04/85/b942092564458ca6d3211c7daafc2a793daefe90bd0bf19c8652cea00c87/qosst_core-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d5cdea734678df5bc2698f50f6a2f0c97c52d4f8504586afcf2680233f6927a",
"md5": "007ee8da6f0517ae62becf03f59d5e4c",
"sha256": "4200e0c9c0f491af651f00d942ee1635d81737b7c25692fd6aee0e95d65830d6"
},
"downloads": -1,
"filename": "qosst_core-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "007ee8da6f0517ae62becf03f59d5e4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 61222,
"upload_time": "2024-04-29T12:38:01",
"upload_time_iso_8601": "2024-04-29T12:38:01.038941Z",
"url": "https://files.pythonhosted.org/packages/1d/5c/dea734678df5bc2698f50f6a2f0c97c52d4f8504586afcf2680233f6927a/qosst_core-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 12:38:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qosst",
"github_project": "qosst-core",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qosst-core"
}