# Welcome to QURI Algo!
QURI Algo is an open source library based on [QURI Parts](https://github.com/QunaSys/quri-parts) featuring ready to use quantum algorithms. QURI Algo provides
- **Interfaces and definitions**: These are built on top of quri-parts and provide convenient abstractions for time-evolution circuits, Hadamard tests, circuit compilation, as well as a type hierarchy for abstract problems, which currently support Quantum Hamiltonians
- **Algorithms**: Quantum algorithms that can be deployed on hardware or simulated directly using estimators and samplers with or without noise
- **Compatibility**: The algorithms provided are fully compatible with QURI Parts. As such they can be easily transpiled to any architecture supported by QURI Parts and other tools made available through the QURI SDK
- **Tutorials**: The tutorials written are instructional in the algorithms used and show the logic behind them as well as showcasing our implementations
To get an overview of QURI Algo, we recommend checking out the tutorials.
## Getting started
Presently QURI Algo requires Python 3.11.1 or later. We recommend installing QURI Algo in a virtual environment using poetry. First make sure to upgrade your pip and virtualenv package. Then create a virtual environment, activate it and within it install poetry
```
$ python -m .venv
$ source .venv/bin/activate
(.venv)$ python -m pip install poetry
```
Then use poetry to install dependencies. If you want to use the circuit cost estimator use
```
(.venv)$ python -m poetry install --with cost-estimator
```
otherwise
```
(.venv)$ python -m poetry install
```
## Documentation
Documentation to QURI Algo is available at [QURI SDK documentation site](https://quri-sdk.qunasys.com/).
## Authors
QURI Algo is developed and maintained by [QynaSys Inc](https://qunasys.com/en/). All contributors can be viewd on [github](https://github.com/QunaSys/quri-algo/graphs/contributors).
## License
QURI Algo is released under an [MIT License](https://github.com/QunaSys/quri-vm/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/QunaSys/quri-algo",
"name": "quri-algo",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "quantum, quantum computing",
"author": "QunaSys",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b6/05/b046c4dc3ead400a47e6be670eb8e62e743a61b8c54dac99a958147fef2a/quri_algo-0.1.1.tar.gz",
"platform": null,
"description": "# Welcome to QURI Algo!\n\nQURI Algo is an open source library based on [QURI Parts](https://github.com/QunaSys/quri-parts) featuring ready to use quantum algorithms. QURI Algo provides\n- **Interfaces and definitions**: These are built on top of quri-parts and provide convenient abstractions for time-evolution circuits, Hadamard tests, circuit compilation, as well as a type hierarchy for abstract problems, which currently support Quantum Hamiltonians\n- **Algorithms**: Quantum algorithms that can be deployed on hardware or simulated directly using estimators and samplers with or without noise\n- **Compatibility**: The algorithms provided are fully compatible with QURI Parts. As such they can be easily transpiled to any architecture supported by QURI Parts and other tools made available through the QURI SDK\n- **Tutorials**: The tutorials written are instructional in the algorithms used and show the logic behind them as well as showcasing our implementations\n\nTo get an overview of QURI Algo, we recommend checking out the tutorials.\n\n## Getting started\n\nPresently QURI Algo requires Python 3.11.1 or later. We recommend installing QURI Algo in a virtual environment using poetry. First make sure to upgrade your pip and virtualenv package. Then create a virtual environment, activate it and within it install poetry\n\n```\n$ python -m .venv\n$ source .venv/bin/activate\n(.venv)$ python -m pip install poetry\n```\n\nThen use poetry to install dependencies. If you want to use the circuit cost estimator use\n\n```\n(.venv)$ python -m poetry install --with cost-estimator\n```\n\notherwise\n\n```\n(.venv)$ python -m poetry install\n```\n\n## Documentation\n\nDocumentation to QURI Algo is available at [QURI SDK documentation site](https://quri-sdk.qunasys.com/).\n\n## Authors\n\nQURI Algo is developed and maintained by [QynaSys Inc](https://qunasys.com/en/). All contributors can be viewd on [github](https://github.com/QunaSys/quri-algo/graphs/contributors).\n\n## License\n\nQURI Algo is released under an [MIT License](https://github.com/QunaSys/quri-vm/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Algorithm library based on QURI Parts",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://quri-sdk.qunasys.com",
"Homepage": "https://github.com/QunaSys/quri-algo",
"Repository": "https://github.com/QunaSys/quri-algo"
},
"split_keywords": [
"quantum",
" quantum computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "261e46b091892edaf34affb4bbab41b631d2f75cdcf5ef8229201aef5782e845",
"md5": "8aecc5421bc3799defbb027e54f9f099",
"sha256": "35502af21c3fa20e61417283618f3245a980469202e284e8b10b13f951446c66"
},
"downloads": -1,
"filename": "quri_algo-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8aecc5421bc3799defbb027e54f9f099",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 50080,
"upload_time": "2024-11-20T06:17:53",
"upload_time_iso_8601": "2024-11-20T06:17:53.559397Z",
"url": "https://files.pythonhosted.org/packages/26/1e/46b091892edaf34affb4bbab41b631d2f75cdcf5ef8229201aef5782e845/quri_algo-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b605b046c4dc3ead400a47e6be670eb8e62e743a61b8c54dac99a958147fef2a",
"md5": "71a514dcb934bc1c12159345702b6750",
"sha256": "a4a31e64d09335ab0b232f77c6f95eed2fa3418a6d1bd0a218606c9c028906d5"
},
"downloads": -1,
"filename": "quri_algo-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "71a514dcb934bc1c12159345702b6750",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 22512,
"upload_time": "2024-11-20T06:17:55",
"upload_time_iso_8601": "2024-11-20T06:17:55.303804Z",
"url": "https://files.pythonhosted.org/packages/b6/05/b046c4dc3ead400a47e6be670eb8e62e743a61b8c54dac99a958147fef2a/quri_algo-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 06:17:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "QunaSys",
"github_project": "quri-algo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "quri-algo"
}
JSON
