Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiskit-community/qiskit-nature
Qiskit Nature is an open-source, quantum computing, framework for solving quantum mechanical natural science problems.
https://github.com/qiskit-community/qiskit-nature
qiskit
Last synced: about 1 month ago
JSON representation
Qiskit Nature is an open-source, quantum computing, framework for solving quantum mechanical natural science problems.
- Host: GitHub
- URL: https://github.com/qiskit-community/qiskit-nature
- Owner: qiskit-community
- License: apache-2.0
- Created: 2021-01-27T16:59:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T19:18:45.000Z (about 2 months ago)
- Last Synced: 2024-05-21T15:18:40.083Z (about 1 month ago)
- Topics: qiskit
- Language: Python
- Homepage: https://qiskit-community.github.io/qiskit-nature/
- Size: 28.5 MB
- Stars: 279
- Watchers: 14
- Forks: 198
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
Lists
- awesome-quantum-software - Qiskit Nature - Quantum Chemistry including ground state, excited states and dipole moment calculations. (Quantum algorithms)
- awesome-qiskit - Qiskit Nature - Qiskit nature allows researchers and developers in different areas of natural sciences (including physics, chemistry, material science and biology) to model and solve domain-specific problems using quantum simulations. (Community)
README
# Qiskit Nature
[](https://opensource.org/licenses/Apache-2.0)[](https://github.com/qiskit-community/qiskit-nature/actions?query=workflow%3A"Nature%20Unit%20Tests"+branch%3Amain+event%3Apush)[](https://github.com/qiskit-community/qiskit-nature/releases)[](https://pypi.org/project/qiskit-nature/)[](https://coveralls.io/github/Qiskit/qiskit-nature?branch=main)
**Qiskit Nature** is an open-source framework which supports solving quantum mechanical natural
science problems using quantum computing algorithms. This includes finding ground and excited
states of electronic and vibrational structure problems, measuring the dipole moments of molecular
systems, solving the Ising and Fermi-Hubbard models on lattices, and much more.
The code comprises various modules revolving around:
- data loading from chemistry drivers or file formats
- second-quantized operator construction and manipulation
- translating from the second-quantized to the qubit space
- a quantum circuit library of natural science targeted ansatze
- natural science specific algorithms and utilities to make the use of
algorithms from [Qiskit Algorithms](https://qiskit-community.github.io/qiskit-algorithms/) easier
- and much more
## Installation
We encourage installing Qiskit Nature via the pip tool (a python package manager).
```bash
pip install qiskit-nature
```
**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 Qiskit Nature, then you can install from source.
To do this follow the instructions in the
[documentation](https://qiskit-community.github.io/qiskit-nature/getting_started.html#installation).
### Optional Installs
To run chemistry experiments using Qiskit Nature, it is recommended that you install
a classical computation chemistry software program/library interfaced by Qiskit.
Several, as listed below, are supported, and while logic to interface these programs is supplied by
Qiskit Nature via the above pip installation, the dependent programs/libraries themselves need
to be installed separately.
- [Gaussian 16™](https://qiskit-community.github.io/qiskit-nature/apidocs/qiskit_nature.second_q.drivers.gaussiand.html), a commercial chemistry program
- [PSI4](https://qiskit-community.github.io/qiskit-nature/apidocs/qiskit_nature.second_q.drivers.psi4d.html), a chemistry program that exposes a Python interface allowing for accessing internal objects
- [PySCF](https://qiskit-community.github.io/qiskit-nature/apidocs/qiskit_nature.second_q.drivers.pyscfd.html), an open-source Python chemistry program
The above codes can be used in a very limited fashion through Qiskit Nature.
While this is useful for getting started and testing purposes, a better experience can be had in the reversed order of responsibility.
That is, in a setup where the classical code runs the Qiskit Nature components.
Such an integration currently exists for the following packages:
- PySCF via [qiskit-nature-pyscf](https://qiskit-community.github.io/qiskit-nature-pyscf/)
If you are interested in using Psi4, we are actively looking for help to get started on a similar integration in [qiskit-nature-psi4](https://github.com/qiskit-community/qiskit-nature-psi4).
Additionally, you may find the following optional dependencies useful:
- [sparse](https://github.com/pydata/sparse/), a library for sparse multi-dimensional arrays. When installed, Qiskit Nature can leverage this to reduce the memory requirements of your calculations.
- [opt_einsum](https://github.com/dgasmith/opt_einsum), a tensor contraction order optimizer for `np.einsum`.
## Creating Your First Chemistry Programming Experiment in Qiskit
Check our [getting started page](https://qiskit-community.github.io/qiskit-nature/getting_started.html)
for a first example on how to use Qiskit Nature.
### Further examples
Learning path notebooks may be found in the
[Nature Tutorials](https://qiskit-community.github.io/qiskit-nature/tutorials/index.html) section
of the documentation and are a great place to start.
----------------------------------------------------------------------------------------------------
## Contribution Guidelines
If you'd like to contribute to Qiskit, please take a look at our
[contribution guidelines](https://github.com/qiskit-community/qiskit-nature/blob/main/CONTRIBUTING.md).
This project adheres to Qiskit's [code of conduct](https://github.com/qiskit-community/qiskit-nature/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-nature/issues) for tracking requests and bugs. Please
[join the Qiskit Slack community](https://qisk.it/join-slack)
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 Nature was inspired, authored and brought about by the collective work of a team of researchers.
Qiskit Nature continues to grow with the help and work of
[many people](https://github.com/qiskit-community/qiskit-nature/graphs/contributors), who contribute
to the project at different levels.
If you use Qiskit Nature, please cite the following references:
- Qiskit, as per the provided [BibTeX file](https://github.com/Qiskit/qiskit/blob/main/CITATION.bib).
- Qiskit Nature, as per https://doi.org/10.5281/zenodo.7828767
## License
This project uses the [Apache License 2.0](https://github.com/qiskit-community/qiskit-nature/blob/main/LICENSE.txt).
However there is some code that is included under other licensing as follows:
* The [Gaussian 16 driver](https://github.com/qiskit-community/qiskit-nature/tree/main/qiskit_nature/second_q/drivers/gaussiand) in `qiskit-nature`
contains [work](https://github.com/qiskit-community/qiskit-nature/tree/main/qiskit_nature/second_q/drivers/gaussiand/gauopen) licensed under the
[Gaussian Open-Source Public License](https://github.com/qiskit-community/qiskit-nature/blob/main/qiskit_nature/second_q/drivers/gaussiand/gauopen/LICENSE.txt).