# qbraid-algorithms
<p align="left">
<a href="https://github.com/qBraid/qbraid-algorithms/actions/workflows/main.yml">
<img src="https://github.com/qBraid/qbraid-algorithms/actions/workflows/main.yml/badge.svg?branch=main" alt="CI"/>
</a>
<a href="https://codecov.io/gh/qBraid/qbraid-algorithms">
<img src="https://codecov.io/gh/qBraid/qbraid-algorithms/graph/badge.svg?token=7jYcnneDys"/>
</a>
<a href="https://pypi.org/project/qbraid-algorithms/">
<img src="https://img.shields.io/pypi/v/qbraid-algorithms.svg?color=blue" alt="PyPI version"/>
</a>
<a href="https://pypi.org/project/qbraid-algorithms/">
<img src="https://img.shields.io/pypi/pyversions/qbraid-algorithms.svg?color=blue" alt="PyPI version"/>
</a>
<a href="https://www.gnu.org/licenses/gpl-3.0.html">
<img src="https://img.shields.io/github/license/qBraid/qbraid.svg" alt="License"/>
</a>
<a href="https://discord.gg/TPBU2sa8Et">
<img src="https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white" alt="Discord"/>
</a>
</p>
Python package for building, simulating, and benchmarking hybrid quantum-classical algorithms.
[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qbraid-algorithms.git)
## Installation
qbraid-algorithms requires Python 3.10 or greater, and can be installed with pip as follows:
```bash
pip install qbraid-algorithms
```
>[!WARNING]
> **This project is "pre-alpha", and is not yet stable or fully realized. Use with caution, as the API and functionality are subject to significant changes.**
### Install from source
You can also install from source by cloning this repository and running a pip install command
in the root directory of the repository:
```bash
git clone https://github.com/qBraid/qbraid-algorithms.git
cd qbraid-algorithms
pip3 install .
```
## Check version
You can view the version of qbraid-algorithms you have installed within a Python shell as follows:
```python
import qbraid_algorithms
qbraid_algorithms.__version__
```
## Community
**We are actively looking for new contributors!**
- Interested in contributing code, or making a PR? See
[CONTRIBUTING.md](CONTRIBUTING.md)
- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/qbraid-algorithms/issues)
- For discussions and/or specific questions about qBraid services, [join our discord community](https://discord.gg/TPBU2sa8Et)
- For questions that are more suited for a forum, post to [Stack Exchange](https://quantumcomputing.stackexchange.com/) with the [`qbraid`](https://quantumcomputing.stackexchange.com/questions/tagged/qbraid) tag.
- By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT).
## Acknowledgements
This project was conceived in cooperation with the Quantum Open Source Foundation ([QOSF](https://qosf.org/)).
<a href="https://qosf.org/"><img src="https://qbraid-static.s3.amazonaws.com/logos/qosf.png" width="100px" style="vertical-align: middle;" /></a>
## License
[GNU General Public License v3.0](LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "qbraid-algorithms",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "qbraid, quantum, algorithms, qml",
"author": "qBraid Development Team",
"author_email": "contact@qbraid.com",
"download_url": "https://files.pythonhosted.org/packages/24/fa/715d3a28950395f54dfb45888ad2f3c5679b55426e1f913a500a2506861c/qbraid_algorithms-0.0.0.tar.gz",
"platform": null,
"description": "# qbraid-algorithms\n\n<p align=\"left\">\n <a href=\"https://github.com/qBraid/qbraid-algorithms/actions/workflows/main.yml\">\n <img src=\"https://github.com/qBraid/qbraid-algorithms/actions/workflows/main.yml/badge.svg?branch=main\" alt=\"CI\"/>\n </a>\n <a href=\"https://codecov.io/gh/qBraid/qbraid-algorithms\"> \n <img src=\"https://codecov.io/gh/qBraid/qbraid-algorithms/graph/badge.svg?token=7jYcnneDys\"/>\n </a>\n <a href=\"https://pypi.org/project/qbraid-algorithms/\">\n <img src=\"https://img.shields.io/pypi/v/qbraid-algorithms.svg?color=blue\" alt=\"PyPI version\"/>\n </a>\n <a href=\"https://pypi.org/project/qbraid-algorithms/\">\n <img src=\"https://img.shields.io/pypi/pyversions/qbraid-algorithms.svg?color=blue\" alt=\"PyPI version\"/>\n </a>\n <a href=\"https://www.gnu.org/licenses/gpl-3.0.html\">\n <img src=\"https://img.shields.io/github/license/qBraid/qbraid.svg\" alt=\"License\"/>\n </a>\n <a href=\"https://discord.gg/TPBU2sa8Et\">\n <img src=\"https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white\" alt=\"Discord\"/>\n </a>\n</p>\n\nPython package for building, simulating, and benchmarking hybrid quantum-classical algorithms.\n\n[<img src=\"https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\" width=\"150\">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qbraid-algorithms.git)\n\n## Installation\n\nqbraid-algorithms requires Python 3.10 or greater, and can be installed with pip as follows:\n\n```bash\npip install qbraid-algorithms\n```\n\n>[!WARNING]\n> **This project is \"pre-alpha\", and is not yet stable or fully realized. Use with caution, as the API and functionality are subject to significant changes.**\n\n### Install from source\n\nYou can also install from source by cloning this repository and running a pip install command\nin the root directory of the repository:\n\n```bash\ngit clone https://github.com/qBraid/qbraid-algorithms.git\ncd qbraid-algorithms\npip3 install .\n```\n\n## Check version\n\nYou can view the version of qbraid-algorithms you have installed within a Python shell as follows:\n\n```python\nimport qbraid_algorithms\n\nqbraid_algorithms.__version__\n```\n\n## Community\n\n**We are actively looking for new contributors!**\n\n- Interested in contributing code, or making a PR? See\n [CONTRIBUTING.md](CONTRIBUTING.md)\n- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/qbraid-algorithms/issues)\n- For discussions and/or specific questions about qBraid services, [join our discord community](https://discord.gg/TPBU2sa8Et)\n- For questions that are more suited for a forum, post to [Stack Exchange](https://quantumcomputing.stackexchange.com/) with the [`qbraid`](https://quantumcomputing.stackexchange.com/questions/tagged/qbraid) tag.\n- By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT).\n\n## Acknowledgements\n\nThis project was conceived in cooperation with the Quantum Open Source Foundation ([QOSF](https://qosf.org/)).\n\n<a href=\"https://qosf.org/\"><img src=\"https://qbraid-static.s3.amazonaws.com/logos/qosf.png\" width=\"100px\" style=\"vertical-align: middle;\" /></a>\n\n## License\n\n[GNU General Public License v3.0](LICENSE)\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Python package for building, simulating, and benchmarking hybrid quantum-classical algorithms.",
"version": "0.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/qBraid/qbraid-algorithms/issues",
"Discord": "https://discord.gg/TPBU2sa8Et",
"Documentation": "https://docs.qbraid.com",
"Homepage": "https://github.com/qBraid/qbraid-algorithms",
"Launch on Lab": "https://account.qbraid.com/?gitHubUrl=https://github.com/qBraid/qbraid-algorithms.git"
},
"split_keywords": [
"qbraid",
" quantum",
" algorithms",
" qml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa5d9253f7d5a9e9c654a97ce281a966940e338676d0bdd8e4491ac2e59df1e4",
"md5": "35f8c52c3869e6905b41173e0b450965",
"sha256": "b5a1ef2b200a9e9c4cddaffc9649ca3a0a4efb368d6a61f9d587e91a855c51e4"
},
"downloads": -1,
"filename": "qbraid_algorithms-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35f8c52c3869e6905b41173e0b450965",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 29933,
"upload_time": "2024-10-15T20:36:10",
"upload_time_iso_8601": "2024-10-15T20:36:10.084850Z",
"url": "https://files.pythonhosted.org/packages/fa/5d/9253f7d5a9e9c654a97ce281a966940e338676d0bdd8e4491ac2e59df1e4/qbraid_algorithms-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24fa715d3a28950395f54dfb45888ad2f3c5679b55426e1f913a500a2506861c",
"md5": "4ad82c00ec6867125689952ab88b5a58",
"sha256": "14da11efdfdeb962aa2441e53ca6f495280b63b8b3c18442fd7ab9c78db457e1"
},
"downloads": -1,
"filename": "qbraid_algorithms-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4ad82c00ec6867125689952ab88b5a58",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 258740,
"upload_time": "2024-10-15T20:36:11",
"upload_time_iso_8601": "2024-10-15T20:36:11.475350Z",
"url": "https://files.pythonhosted.org/packages/24/fa/715d3a28950395f54dfb45888ad2f3c5679b55426e1f913a500a2506861c/qbraid_algorithms-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 20:36:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qBraid",
"github_project": "qbraid-algorithms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qbraid-algorithms"
}
JSON
