Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiskit-community/qiskit-algorithms
A library of quantum algorithms for Qiskit.
https://github.com/qiskit-community/qiskit-algorithms
qiskit
Last synced: 17 days ago
JSON representation
A library of quantum algorithms for Qiskit.
- Host: GitHub
- URL: https://github.com/qiskit-community/qiskit-algorithms
- Owner: qiskit-community
- License: apache-2.0
- Created: 2023-07-17T13:59:54.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-11T13:07:48.000Z (19 days ago)
- Last Synced: 2024-06-12T18:56:12.901Z (18 days ago)
- Topics: qiskit
- Language: Python
- Homepage: https://qiskit-community.github.io/qiskit-algorithms/
- Size: 15.2 MB
- Stars: 87
- Watchers: 6
- Forks: 43
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Lists
- awesome-qiskit - Qiskit Algorithms - Qiskit algorithms is a library of quantum algorithms based on qiskit, suitable to run on near-term quantum devices with short-depth circuits. (Community)
README
# Qiskit Algorithms
[](https://opensource.org/licenses/Apache-2.0)[](https://github.com/qiskit-community/qiskit-algorithms/actions?query=workflow%3A"Algorithms%20Unit%20Tests"+branch%3Amain+event%3Apush)[](https://github.com/qiskit-community/qiskit-algorithms/releases)[](https://pypi.org/project/qiskit-algorithms/)[](https://coveralls.io/github/qiskit-community/qiskit-algorithms?branch=main)
> [!WARNING]
> **Qiskit Algorithms is no longer officially supported by IBM**.
> Like any other Apache 2 licensed code, you are free to use it or/and extend it, but please be aware that it is under your own risk.
## 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).