| Name | qadence-protocols JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | |
| Summary | Protocols interface for running experiments using Qadence. |
| upload_time | 2024-02-07 10:35:29 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | <3.12,>=3.9 |
| license | Apache 2.0 |
| keywords |
quantum
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Qadence-Protocols
**Qadence-Protocols** is a Python package that provides extra functionality for Qadence.
[](https://github.com/pasqal-io/qadence-protocols/actions/workflows/lint.yml)
[](https://github.com/pasqal-io/qadence-protocols/actions/workflows/test.yml)
[](https://pasqal-io.github.io/qadence-protocols/latest)
[](https://pypi.org/project/qadence-protocols/)
[](https://opensource.org/licenses/Apache-2.0)
## Installation guide
[PyPI](https://pypi.org/project/qadence-protocols/) and can be installed using `pip` as follows:
```bash
pip install qadence_protocols
```
## Contributing
Before making a contribution, please review our [code of conduct](docs/CODE_OF_CONDUCT.md).
- **Submitting Issues:** To submit bug reports or feature requests, please use our [issue tracker](https://github.com/pasqal-io/qadence-protocols/issues).
- **Developing in qadence:** To learn more about how to develop within `qadence`, please refer to [contributing guidelines](docs/CONTRIBUTING.md).
### Setting up qadence in development mode
We recommend to use the [`hatch`](https://hatch.pypa.io/latest/) environment manager to install `qadence_protocols` from source:
```bash
python -m pip install hatch
# get into a shell with all the dependencies
python -m hatch shell
# run a command within the virtual environment with all the dependencies
python -m hatch run python my_script.py
```
**WARNING**
`hatch` will not combine nicely with other environment managers such as Conda. If you still want to use Conda,
install it from source using `pip`:
```bash
# within the Conda environment
python -m pip install -e .
```
## Citation
If you use Qadence-Protocols for a publication, we kindly ask you to cite our work using the following BibTex entry:
```latex
@misc{qadence-protocols2024pasqal,
url = {https://github.com/pasqal-io/qadence-protocols},
title = {Qadence Protocols: {A}n {E}xperiment runner for Qadence.},
year = {2023}
}
```
## License
Qadence-Protocols is a free and open source software package, released under the Apache License, Version 2.0.
Raw data
{
"_id": null,
"home_page": "",
"name": "qadence-protocols",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": "",
"keywords": "quantum",
"author": "",
"author_email": "Mario Dagrada <mario.dagrada@pasqal.com>, Roland Guichard <roland.guichard@pasqal.com>, Raja Selvarajan <raja.selvarajan@pasqal.com>, Gergana Velikova <gergana.velikova@pasqal.com>",
"download_url": "https://files.pythonhosted.org/packages/61/aa/d19bcc55ce071157e062c900949631d8a21f11eaa3e7df46ac830abc4a6e/qadence_protocols-0.1.5.tar.gz",
"platform": null,
"description": "# Qadence-Protocols\n\n**Qadence-Protocols** is a Python package that provides extra functionality for Qadence.\n\n[](https://github.com/pasqal-io/qadence-protocols/actions/workflows/lint.yml)\n[](https://github.com/pasqal-io/qadence-protocols/actions/workflows/test.yml)\n[](https://pasqal-io.github.io/qadence-protocols/latest)\n[](https://pypi.org/project/qadence-protocols/)\n[](https://opensource.org/licenses/Apache-2.0)\n\n\n## Installation guide\n\n[PyPI](https://pypi.org/project/qadence-protocols/) and can be installed using `pip` as follows:\n\n```bash\npip install qadence_protocols\n```\n\n## Contributing\n\nBefore making a contribution, please review our [code of conduct](docs/CODE_OF_CONDUCT.md).\n\n- **Submitting Issues:** To submit bug reports or feature requests, please use our [issue tracker](https://github.com/pasqal-io/qadence-protocols/issues).\n- **Developing in qadence:** To learn more about how to develop within `qadence`, please refer to [contributing guidelines](docs/CONTRIBUTING.md).\n\n### Setting up qadence in development mode\n\nWe recommend to use the [`hatch`](https://hatch.pypa.io/latest/) environment manager to install `qadence_protocols` from source:\n\n```bash\npython -m pip install hatch\n\n# get into a shell with all the dependencies\npython -m hatch shell\n\n# run a command within the virtual environment with all the dependencies\npython -m hatch run python my_script.py\n```\n\n**WARNING**\n`hatch` will not combine nicely with other environment managers such as Conda. If you still want to use Conda,\ninstall it from source using `pip`:\n\n```bash\n# within the Conda environment\npython -m pip install -e .\n```\n\n## Citation\n\nIf you use Qadence-Protocols for a publication, we kindly ask you to cite our work using the following BibTex entry:\n\n```latex\n@misc{qadence-protocols2024pasqal,\n url = {https://github.com/pasqal-io/qadence-protocols},\n title = {Qadence Protocols: {A}n {E}xperiment runner for Qadence.},\n year = {2023}\n}\n```\n\n## License\nQadence-Protocols is a free and open source software package, released under the Apache License, Version 2.0.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Protocols interface for running experiments using Qadence.",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"quantum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c78e1dfe145857275115a30cd8dc86fd342dc5417b984bcc5c9e873ac638f89",
"md5": "95fffc8c7e12a529d2ac16a9a8189615",
"sha256": "35279318a5edd0ad9ab8fdabdf046c5d5aa0d1b4b48a70a2a1bbb4fe0bb676d8"
},
"downloads": -1,
"filename": "qadence_protocols-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95fffc8c7e12a529d2ac16a9a8189615",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 15365,
"upload_time": "2024-02-07T10:35:28",
"upload_time_iso_8601": "2024-02-07T10:35:28.698990Z",
"url": "https://files.pythonhosted.org/packages/9c/78/e1dfe145857275115a30cd8dc86fd342dc5417b984bcc5c9e873ac638f89/qadence_protocols-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61aad19bcc55ce071157e062c900949631d8a21f11eaa3e7df46ac830abc4a6e",
"md5": "8f329fe0819bc2104490b52fb8cf00a1",
"sha256": "d17a5efebec52b8f6d94b961e75c60c33b867e3359abca654c90d0d8467f34de"
},
"downloads": -1,
"filename": "qadence_protocols-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "8f329fe0819bc2104490b52fb8cf00a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 15308,
"upload_time": "2024-02-07T10:35:29",
"upload_time_iso_8601": "2024-02-07T10:35:29.714001Z",
"url": "https://files.pythonhosted.org/packages/61/aa/d19bcc55ce071157e062c900949631d8a21f11eaa3e7df46ac830abc4a6e/qadence_protocols-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 10:35:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qadence-protocols"
}
