# Qiskit Algorithms
[](https://opensource.org/licenses/Apache-2.0)
## Installation
We encourage installing Qiskit Algorithms via the pip tool (a python package manager).
```bash
pip install qiskit-algorithms
```
**pip** will handle all dependencies automatically and you will always install the latest
(and well-tested) version.
If you want to work on the very latest work-in-progress versions, either to try features ahead of
their official release or if you want to contribute to Algorithms, then you can install from source.
To do this follow the instructions in the
[documentation](https://qiskit-community.github.io/qiskit-algorithms/getting_started.html#installation).
----------------------------------------------------------------------------------------------------
### Optional Installs
Some optimization algorithms require specific libraries to be run:
* **Scikit-quant**, may be installed using the command `pip install scikit-quant`.
* **SnobFit**, may be installed using the command `pip install SQSnobFit`.
* **NLOpt**, may be installed using the command `pip install nlopt`.
[//]: # (### Creating Your First Algorithm in Qiskit)
[//]: # (### Further examples)
----------------------------------------------------------------------------------------------------
## Contribution Guidelines
If you'd like to contribute to Qiskit Algorithms, please take a look at our
[contribution guidelines](https://github.com/qiskit-community/qiskit-algorithms/blob/main/CONTRIBUTING.md).
This project adheres to Qiskit's [code of conduct](https://github.com/qiskit-community/qiskit-algorithms/blob/main/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.
We use [GitHub issues](https://github.com/qiskit-community/qiskit-algorithms/issues) for tracking requests and bugs. Please
[join the Qiskit Slack community](https://qisk.it/join-slack)
and for discussion and simple questions.
For questions that are more suited for a forum, we use the **Qiskit** tag in [Stack Overflow](https://stackoverflow.com/questions/tagged/qiskit).
## Authors and Citation
Qiskit Algorithms was inspired, authored and brought about by the collective work of a team of researchers.
Algorithms continues to grow with the help and work of
[many people](https://github.com/qiskit-community/qiskit-algorithms/graphs/contributors), who contribute
to the project at different levels.
If you use Qiskit, please cite as per the provided
[BibTeX file](https://github.com/Qiskit/qiskit/blob/main/CITATION.bib).
## License
This project uses the [Apache License 2.0](https://github.com/qiskit-community/qiskit-algorithms/blob/main/LICENSE.txt).
Raw data
{
"_id": null,
"home_page": "https://github.com/qiskit-community/qiskit-algorithms",
"name": "qiskit-algorithms",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "qiskit sdk quantum algorithms",
"author": "Qiskit Algorithms Development Team",
"author_email": "qiskit@us.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/b6/b0/277f075f4758c474f026f2ffc9b6246b2cbe5658fbc95497764834685e15/qiskit_algorithms-0.3.1.tar.gz",
"platform": null,
"description": "# Qiskit Algorithms\n\n[](https://opensource.org/licenses/Apache-2.0)\n\n## Installation\n\nWe encourage installing Qiskit Algorithms via the pip tool (a python package manager).\n\n```bash\npip install qiskit-algorithms\n```\n\n**pip** will handle all dependencies automatically and you will always install the latest\n(and well-tested) version.\n\nIf you want to work on the very latest work-in-progress versions, either to try features ahead of\ntheir official release or if you want to contribute to Algorithms, then you can install from source.\nTo do this follow the instructions in the\n [documentation](https://qiskit-community.github.io/qiskit-algorithms/getting_started.html#installation).\n\n\n----------------------------------------------------------------------------------------------------\n\n### Optional Installs\n\nSome optimization algorithms require specific libraries to be run:\n\n* **Scikit-quant**, may be installed using the command `pip install scikit-quant`.\n\n* **SnobFit**, may be installed using the command `pip install SQSnobFit`.\n\n* **NLOpt**, may be installed using the command `pip install nlopt`.\n\n[//]: # (### Creating Your First Algorithm in Qiskit)\n\n[//]: # (### Further examples)\n\n----------------------------------------------------------------------------------------------------\n\n## Contribution Guidelines\n\nIf you'd like to contribute to Qiskit Algorithms, please take a look at our\n[contribution guidelines](https://github.com/qiskit-community/qiskit-algorithms/blob/main/CONTRIBUTING.md).\nThis project adheres to Qiskit's [code of conduct](https://github.com/qiskit-community/qiskit-algorithms/blob/main/CODE_OF_CONDUCT.md).\nBy participating, you are expected to uphold this code.\n\nWe use [GitHub issues](https://github.com/qiskit-community/qiskit-algorithms/issues) for tracking requests and bugs. Please\n[join the Qiskit Slack community](https://qisk.it/join-slack)\nand for discussion and simple questions.\nFor questions that are more suited for a forum, we use the **Qiskit** tag in [Stack Overflow](https://stackoverflow.com/questions/tagged/qiskit).\n\n## Authors and Citation\n\nQiskit Algorithms was inspired, authored and brought about by the collective work of a team of researchers.\nAlgorithms continues to grow with the help and work of\n[many people](https://github.com/qiskit-community/qiskit-algorithms/graphs/contributors), who contribute\nto the project at different levels.\nIf you use Qiskit, please cite as per the provided\n[BibTeX file](https://github.com/Qiskit/qiskit/blob/main/CITATION.bib).\n\n## License\n\nThis project uses the [Apache License 2.0](https://github.com/qiskit-community/qiskit-algorithms/blob/main/LICENSE.txt).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Qiskit Algorithms: A library of quantum computing algorithms",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/qiskit-community/qiskit-algorithms/issues",
"Documentation": "https://qiskit-community.github.io/qiskit-algorithms/",
"Homepage": "https://github.com/qiskit-community/qiskit-algorithms",
"Source Code": "https://github.com/qiskit-community/qiskit-algorithms"
},
"split_keywords": [
"qiskit",
"sdk",
"quantum",
"algorithms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9200db766da89de14111c4a1217dbb67d19036eb3e4ffba0fdc25f00e4d1615",
"md5": "cd797da3d0ddf65429f41e272c9a9906",
"sha256": "d6c31d88a1ed65a9c6382c233ef10ecb9562e726f7b1b7823a0d178d63d29a0a"
},
"downloads": -1,
"filename": "qiskit_algorithms-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd797da3d0ddf65429f41e272c9a9906",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 310548,
"upload_time": "2024-10-21T11:03:19",
"upload_time_iso_8601": "2024-10-21T11:03:19.907554Z",
"url": "https://files.pythonhosted.org/packages/f9/20/0db766da89de14111c4a1217dbb67d19036eb3e4ffba0fdc25f00e4d1615/qiskit_algorithms-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6b0277f075f4758c474f026f2ffc9b6246b2cbe5658fbc95497764834685e15",
"md5": "20c84d085d6dcf0dac0dd6e5575dd542",
"sha256": "cba9c573d47c0f9508745a5a2794298084ec4f8833781b426fa9b2cea0fca794"
},
"downloads": -1,
"filename": "qiskit_algorithms-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "20c84d085d6dcf0dac0dd6e5575dd542",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 243033,
"upload_time": "2024-10-21T11:03:21",
"upload_time_iso_8601": "2024-10-21T11:03:21.707858Z",
"url": "https://files.pythonhosted.org/packages/b6/b0/277f075f4758c474f026f2ffc9b6246b2cbe5658fbc95497764834685e15/qiskit_algorithms-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 11:03:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qiskit-community",
"github_project": "qiskit-algorithms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "qiskit",
"specs": [
[
">=",
"0.44"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.4"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.17"
]
]
}
],
"tox": true,
"lcname": "qiskit-algorithms"
}
JSON
