50 lines
4.3 KiB
Plaintext
50 lines
4.3 KiB
Plaintext
---
|
||
title: aqua (v0.31)
|
||
description: API reference for qiskit.aqua in qiskit v0.31
|
||
in_page_toc_min_heading_level: 2
|
||
python_api_type: module
|
||
python_api_name: qiskit.aqua
|
||
---
|
||
|
||
<span id="module-qiskit.aqua" />
|
||
|
||
<span id="qiskit-aqua" />
|
||
|
||
<span id="aqua-algorithms-for-quantum-applications-qiskit-aqua" />
|
||
|
||
# Aqua (Algorithms for QUantum Applications)
|
||
|
||
`qiskit.aqua`
|
||
|
||
Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices.
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------- | --------------------------------- |
|
||
| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. |
|
||
|
||
Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too).
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |
|
||
| [`AquaError`](qiskit.aqua.AquaError "qiskit.aqua.AquaError") | Base class for errors raised by Aqua. |
|
||
| [`MissingOptionalLibraryError`](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") | Raised when an optional library is missing. |
|
||
|
||
In addition to standard Python errors Aqua will raise this error if circumstances are that it cannot proceed to completion.
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------ | -------------------------------------------- |
|
||
| [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") | Quantum Backend including execution setting. |
|
||
|
||
A QuantumInstance holds the Qiskit backend as well as a number of compile and runtime parameters controlling circuit compilation and execution. Aqua’s quantum [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") are run on a device or simulator by passing a QuantumInstance setup with the desired backend etc.
|
||
|
||
## Submodules
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||
| [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") | Algorithms ([`qiskit.aqua.algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms")) |
|
||
| [`components`](qiskit.aqua.components#module-qiskit.aqua.components "qiskit.aqua.components") | Components ([`qiskit.aqua.components`](qiskit.aqua.components#module-qiskit.aqua.components "qiskit.aqua.components")) |
|
||
| [`circuits`](qiskit.aqua.circuits#module-qiskit.aqua.circuits "qiskit.aqua.circuits") | Circuits ([`qiskit.aqua.circuits`](qiskit.aqua.circuits#module-qiskit.aqua.circuits "qiskit.aqua.circuits")) |
|
||
| [`operators`](qiskit.aqua.operators#module-qiskit.aqua.operators "qiskit.aqua.operators") | Operators ([`qiskit.aqua.operators`](qiskit.aqua.operators#module-qiskit.aqua.operators "qiskit.aqua.operators")) |
|
||
| [`utils`](qiskit.aqua.utils#module-qiskit.aqua.utils "qiskit.aqua.utils") | Utilities ([`qiskit.aqua.utils`](qiskit.aqua.utils#module-qiskit.aqua.utils "qiskit.aqua.utils")) |
|
||
|