Name | qadence-libs JSON |
Version |
0.1.1
JSON |
| download |
home_page | |
Summary | Libraries to extend Qadence functionalities. |
upload_time | 2024-02-06 14:31:53 |
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-Libs
**Qadence-Libs** is a Python package that provides extra functionality for Qadence.
[![Linting](https://github.com/pasqal-io/qadence-libs/actions/workflows/lint.yml/badge.svg)](https://github.com/pasqal-io/qadence-libs/actions/workflows/lint.yml)
[![Tests](https://github.com/pasqal-io/qadence-libs/actions/workflows/test_fast.yml/badge.svg)](https://github.com/pasqal-io/qadence-libs/actions/workflows/test.yml)
[![Documentation](https://github.com/pasqal-io/qadence-libs/actions/workflows/build_docs.yml/badge.svg)](https://pasqal-io.github.io/qadence-libs/latest)
[![Pypi](https://badge.fury.io/py/qadence-libs.svg)](https://pypi.org/project/qadence-libs/)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
## Installation guide
[PyPI](https://pypi.org/project/qadence-libs/) and can be installed using `pip` as follows:
```bash
pip install qadence_libs
```
## 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-libs/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_libs` 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-Libs for a publication, we kindly ask you to cite our work using the following BibTex entry:
```latex
@misc{qadence-libs2024pasqal,
url = {https://github.com/pasqal-io/qadence-libs},
title = {Qadence Libs: {A}n {E}xperiment runner for Qadence.},
year = {2023}
}
```
## License
Qadence-Libs is a free and open source software package, released under the Apache License, Version 2.0.
Raw data
{
"_id": null,
"home_page": "",
"name": "qadence-libs",
"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/c6/24/c4a4ab6f871b7407db2f08d3be9149914f92a049efcfdab9482ea7619c4d/qadence_libs-0.1.1.tar.gz",
"platform": null,
"description": "# Qadence-Libs\n\n**Qadence-Libs** is a Python package that provides extra functionality for Qadence.\n\n[![Linting](https://github.com/pasqal-io/qadence-libs/actions/workflows/lint.yml/badge.svg)](https://github.com/pasqal-io/qadence-libs/actions/workflows/lint.yml)\n[![Tests](https://github.com/pasqal-io/qadence-libs/actions/workflows/test_fast.yml/badge.svg)](https://github.com/pasqal-io/qadence-libs/actions/workflows/test.yml)\n[![Documentation](https://github.com/pasqal-io/qadence-libs/actions/workflows/build_docs.yml/badge.svg)](https://pasqal-io.github.io/qadence-libs/latest)\n[![Pypi](https://badge.fury.io/py/qadence-libs.svg)](https://pypi.org/project/qadence-libs/)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\n## Installation guide\n\n[PyPI](https://pypi.org/project/qadence-libs/) and can be installed using `pip` as follows:\n\n```bash\npip install qadence_libs\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-libs/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_libs` 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-Libs for a publication, we kindly ask you to cite our work using the following BibTex entry:\n\n```latex\n@misc{qadence-libs2024pasqal,\n url = {https://github.com/pasqal-io/qadence-libs},\n title = {Qadence Libs: {A}n {E}xperiment runner for Qadence.},\n year = {2023}\n}\n```\n\n## License\nQadence-Libs 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": "Libraries to extend Qadence functionalities.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"quantum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "407b1299ac752d068cb07f470ec15cb478f69576a7a64ee6bf07f8f1ea6a4b14",
"md5": "b9ad2ae54c143f492754930b326836e7",
"sha256": "c5ef92a72e0a6b1e9e2a3b174d843d59fe9c16afd3ae57a69d9fa2124d747c66"
},
"downloads": -1,
"filename": "qadence_libs-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9ad2ae54c143f492754930b326836e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 6775,
"upload_time": "2024-02-06T14:31:52",
"upload_time_iso_8601": "2024-02-06T14:31:52.442671Z",
"url": "https://files.pythonhosted.org/packages/40/7b/1299ac752d068cb07f470ec15cb478f69576a7a64ee6bf07f8f1ea6a4b14/qadence_libs-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c624c4a4ab6f871b7407db2f08d3be9149914f92a049efcfdab9482ea7619c4d",
"md5": "0a7860f012688a4d0666df990ba36aa6",
"sha256": "c63670b77a659da8aa4a203d292f16e96afae260100dabd5765e190110ec7765"
},
"downloads": -1,
"filename": "qadence_libs-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0a7860f012688a4d0666df990ba36aa6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 9546,
"upload_time": "2024-02-06T14:31:53",
"upload_time_iso_8601": "2024-02-06T14:31:53.988125Z",
"url": "https://files.pythonhosted.org/packages/c6/24/c4a4ab6f871b7407db2f08d3be9149914f92a049efcfdab9482ea7619c4d/qadence_libs-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-06 14:31:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qadence-libs"
}