Regeneration Qiskit v0.42 API docs (Qiskit#658)

Part of Qiskit#542. Regeneration of the Qiskit API docs (historical versions) with the methods inlined and the GitHub source links. Given the number of files modified, the regeneration is split into different PRs. This one only updates the version 0.42. The rest of the versions will be added in follow-up PRs in batches of two versions.
frankharkins · Jan 19, 2024 · 7f1b2cf · 7f1b2cf
1 parent 8185484
commit 7f1b2cf
Show file tree

Hide file tree

Showing 1,204 changed files with 4,426 additions and 5,172 deletions.
diff --git a/docs/api/qiskit/0.42/_toc.json b/docs/api/qiskit/0.42/_toc.json
@@ -2930,10 +2930,6 @@
           "title": "Constant",
           "url": "/api/qiskit/0.42/qiskit.pulse.library.Constant"
         },
-        {
-          "title": "constant",
-          "url": "/api/qiskit/0.42/qiskit.pulse.library.constant"
-        },
         {
           "title": "control_channels",
           "url": "/api/qiskit/0.42/qiskit.pulse.builder.control_channels"
@@ -2966,10 +2962,6 @@
           "title": "Drag",
           "url": "/api/qiskit/0.42/qiskit.pulse.library.Drag"
         },
-        {
-          "title": "drag",
-          "url": "/api/qiskit/0.42/qiskit.pulse.library.drag"
-        },
         {
           "title": "drive_channel",
           "url": "/api/qiskit/0.42/qiskit.pulse.builder.drive_channel"
@@ -2990,10 +2982,6 @@
           "title": "Gaussian",
           "url": "/api/qiskit/0.42/qiskit.pulse.library.Gaussian"
         },
-        {
-          "title": "gaussian",
-          "url": "/api/qiskit/0.42/qiskit.pulse.library.gaussian"
-        },
         {
           "title": "gaussian_deriv",
           "url": "/api/qiskit/0.42/qiskit.pulse.library.gaussian_deriv"

diff --git a/docs/api/qiskit/0.42/aer.md b/docs/api/qiskit/0.42/aer.md
@@ -1,6 +1,6 @@
 <span id="qiskit-aer" />
 
-# Qiskit Aer API Reference[¶](#qiskit-aer-api-reference "Permalink to this headline")
+# Qiskit Aer API Reference
 
 *   [Aer Provider (`qiskit_aer`)](aer_provider)
 *   [Aer Jobs (`qiskit_aer.jobs`)](aer_jobs)

diff --git a/docs/api/qiskit/0.42/aer_jobs.md b/docs/api/qiskit/0.42/aer_jobs.md
@@ -12,16 +12,12 @@ python_api_name: qiskit_aer.jobs
 
 <span id="module-qiskit_aer.jobs" />
 
-`qiskit_aer.jobs¶`
+`qiskit_aer.jobs`
 
 This module contains classes and functions to manage Aer jobs.
 
 ## Classes
 
-<span id="module-qiskit_aer.jobs" />
-
-`¶`
-
 The following are the classes used to manage job submissions.
 
 |                                                                                                         |                                                                                                         |

diff --git a/docs/api/qiskit/0.42/aer_library.md b/docs/api/qiskit/0.42/aer_library.md
@@ -14,19 +14,15 @@ python_api_name: qiskit_aer.library
 
 <span id="module-qiskit_aer.library" />
 
-`qiskit_aer.library¶`
+`qiskit_aer.library`
 
 This library contains custom qiskit `QuantumCircuit` [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") subclasses that can be used with the Aer circuit simulator backends.
 
 ## Setting a Custom Simulator State
 
-<span id="module-qiskit_aer.library" />
-
-`¶`
-
 The following instruction classes can be used to set the specific simulator methods to a custom state. Note that these instructions are only valid when applied to all qubits in a circuit. Applying to a subset of qubits will raise an exception during execution.
 
-### Instruction Classes[¶](#instruction-classes "Permalink to this headline")
+### Instruction Classes
 
 |                                                                                                                       |                                                    |
 | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
@@ -37,7 +33,7 @@ The following instruction classes can be used to set the specific simulator meth
 | [`SetUnitary`](qiskit_aer.library.SetUnitary "qiskit_aer.library.SetUnitary")(state)                                  | Set unitary state of the simulator                 |
 | [`SetMatrixProductState`](qiskit_aer.library.SetMatrixProductState "qiskit_aer.library.SetMatrixProductState")(state) | Set the matrix product state of the simulator      |
 
-### QuantumCircuit Methods[¶](#quantumcircuit-methods "Permalink to this headline")
+### QuantumCircuit Methods
 
 The set instructions can also be added to circuits by using the following `QuantumCircuit` methods which are patched when importing Aer.
 
@@ -52,11 +48,7 @@ The set instructions can also be added to circuits by using the following `Quant
 
 ## Saving Simulator Data
 
-<span id="module-qiskit_aer.library" />
-
-`¶`
-
-### Simulator State Save Instruction Classes[¶](#simulator-state-save-instruction-classes "Permalink to this headline")
+### Simulator State Save Instruction Classes
 
 The following instructions can be used to save the state of the simulator into the returned result object. The [`SaveState`](qiskit_aer.library.SaveState "qiskit_aer.library.SaveState") instruction will automatically select the format based on the simulation method (eg. [`SaveStatevector`](qiskit_aer.library.SaveStatevector "qiskit_aer.library.SaveStatevector") for statevector method, [`SaveDensityMatrix`](qiskit_aer.library.SaveDensityMatrix "qiskit_aer.library.SaveDensityMatrix") for density matrix method etc.).
 
@@ -80,7 +72,7 @@ The following instructions can be used to save the state of the simulator into t
   The [`StatevectorSimulator`](qiskit_aer.StatevectorSimulator "qiskit_aer.StatevectorSimulator") (and [`UnitarySimulator`](qiskit_aer.UnitarySimulator "qiskit_aer.UnitarySimulator")) backend automatically append every run circuit with the a ``SaveStatevector`()`` (``SaveUnitary`()``) instruction using the default label. Hence adding any additional save instructions of that type will require specifying a custom label for those instructions.
 </Admonition>
 
-### Simulator Derived Data Save Instruction Classes[¶](#simulator-derived-data-save-instruction-classes "Permalink to this headline")
+### Simulator Derived Data Save Instruction Classes
 
 The following classes can be used to directly save data derived from the simulator state to the returned result object. One some are compatible with certain simulation methods.
 
@@ -105,7 +97,7 @@ For convenience the save instructions can be accessed using custom `QuantumCircu
   In both these cases only a single shot is actually simulated and measurement samples for all shots are calculated from the final state.
 </Admonition>
 
-### QuantumCircuit Methods[¶](#id1 "Permalink to this headline")
+### QuantumCircuit Methods
 
 The save instructions can also be added to circuits by using the following `QuantumCircuit` methods which are patched when importing Aer.
 
@@ -133,10 +125,6 @@ The save instructions can also be added to circuits by using the following `Quan
 
 ## Method Compatibility
 
-<span id="module-qiskit_aer.library" />
-
-`¶`
-
 The following table summarizes which instructions are compatible with which simulation methods
 
 | Instruction                                                                                                                         | Automatic | Statevector | Density Matrix | MPS | Stabilizer | Ext. Stabilizer | Unitary | SuperOp |

diff --git a/docs/api/qiskit/0.42/aer_noise.md b/docs/api/qiskit/0.42/aer_noise.md
@@ -14,19 +14,15 @@ python_api_name: qiskit_aer.noise
 
 <span id="module-qiskit_aer.noise" />
 
-`qiskit_aer.noise¶`
+`qiskit_aer.noise`
 
 This module contains classes and functions to build a noise model for simulating a Qiskit quantum circuit in the presence of errors.
 
 ## Building Noise Models
 
-<span id="module-qiskit_aer.noise" />
-
-`¶`
-
 The [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") class is used to represent noise model for the [`QasmSimulator`](qiskit_aer.QasmSimulator "qiskit_aer.QasmSimulator"). It can be used to construct custom noise models for simulator, to to automatically generate a basic device noise model for an IBMQ backend.
 
-### Device Noise Models[¶](#device-noise-models "Permalink to this headline")
+### Device Noise Models
 
 A simplified approximate [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") can be generated automatically from the properties of real device backends from the IBMQ provider using the [`NoiseModel.from_backend()`](qiskit_aer.noise.NoiseModel#from_backend "qiskit_aer.noise.NoiseModel.from_backend") method. See the method documentation for details.
 
@@ -65,7 +61,7 @@ counts = result.get_counts(0)
 plot_histogram(counts)
 ```
 
-### Custom Noise Models[¶](#custom-noise-models "Permalink to this headline")
+### Custom Noise Models
 
 Custom noise models can be used by adding [`QuantumError`](qiskit_aer.noise.QuantumError "qiskit_aer.noise.QuantumError") to circuit gate, reset or measure instructions, and [`ReadoutError`](qiskit_aer.noise.ReadoutError "qiskit_aer.noise.ReadoutError") to measure instructions. This module includes several helper functions for generating [`QuantumError`](qiskit_aer.noise.QuantumError "qiskit_aer.noise.QuantumError") instances based on canonical error models used in Quantum Information Theory that can simplify building noise models. See the documentation for the [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") class for additional details.
 
@@ -109,10 +105,6 @@ plot_histogram(counts)
 
 ## Classes
 
-<span id="module-qiskit_aer.noise" />
-
-`¶`
-
 The following are the classes used to represented noise and error terms.
 
 |                                                                                                         |                                                 |
@@ -123,10 +115,6 @@ The following are the classes used to represented noise and error terms.
 
 ## Quantum Error Functions
 
-<span id="module-qiskit_aer.noise" />
-
-`¶`
-
 The following functions can be used to generate many common types of [`QuantumError`](qiskit_aer.noise.QuantumError "qiskit_aer.noise.QuantumError") objects for inclusion in a [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel").
 
 |                                                                                                                                                     |                                                                                   |
@@ -144,10 +132,6 @@ The following functions can be used to generate many common types of [`QuantumEr
 
 ## Noise Transpiler Passes
 
-<span id="module-qiskit_aer.noise" />
-
-`¶`
-
 These transpiler passes can be used to build noise models that can be applied to circuits via transpilation.
 
 |                                                                                                                            |                                                                     |
@@ -157,10 +141,6 @@ These transpiler passes can be used to build noise models that can be applied to
 
 ## Device Noise Parameters
 
-<span id="module-qiskit_aer.noise" />
-
-`¶`
-
 The following are utility functions which can be used for extracting error parameters and error objects from device BackendProperties.
 
 |                                                                                                                                                           |                                                                                    |

diff --git a/docs/api/qiskit/0.42/aer_primitives.md b/docs/api/qiskit/0.42/aer_primitives.md
@@ -14,16 +14,12 @@ python_api_name: qiskit_aer.primitives
 
 <span id="module-qiskit_aer.primitives" />
 
-`qiskit_aer.primitives¶`
+`qiskit_aer.primitives`
 
 This module is Aer implementation of primitives. See the docs [https://qiskit.org/documentation/apidoc/primitives.html](https://qiskit.org/documentation/apidoc/primitives.html) for general descriptions.
 
 ## Classes
 
-<span id="module-qiskit_aer.primitives" />
-
-`¶`
-
 |                                                                                                                |                                      |
 | -------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
 | [`Sampler`](qiskit_aer.primitives.Sampler "qiskit_aer.primitives.Sampler")(\*\[, backend\_options, ...])       | Aer implementation of Sampler class. |

diff --git a/docs/api/qiskit/0.42/aer_provider.md b/docs/api/qiskit/0.42/aer_provider.md
@@ -12,35 +12,23 @@ python_api_name: qiskit_aer
 
 <span id="module-qiskit_aer" />
 
-`qiskit_aer¶`
+`qiskit_aer`
 
 ## Simulator Provider
 
-<span id="module-qiskit_aer" />
-
-`¶`
-
 |                                                                    |                                   |
 | ------------------------------------------------------------------ | --------------------------------- |
 | [`AerProvider`](qiskit_aer.AerProvider "qiskit_aer.AerProvider")() | Provider for Qiskit Aer backends. |
 
 ## Simulator Backends
 
-<span id="module-qiskit_aer" />
-
-`¶`
-
 |                                                                                                              |                                               |
 | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------- |
 | [`AerSimulator`](qiskit_aer.AerSimulator "qiskit_aer.AerSimulator")(\[configuration, properties, ...])       | Noisy quantum circuit simulator backend.      |
 | [`PulseSimulator`](qiskit_aer.PulseSimulator "qiskit_aer.PulseSimulator")(\[configuration, properties, ...]) | Deprecated: Pulse schedule simulator backend. |
 
 ## Legacy Simulator Backends
 
-<span id="module-qiskit_aer" />
-
-`¶`
-
 |                                                                                                                    |                                             |
 | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |
 | [`QasmSimulator`](qiskit_aer.QasmSimulator "qiskit_aer.QasmSimulator")(\[configuration, properties, ...])          | Noisy quantum circuit simulator backend.    |
@@ -49,10 +37,6 @@ python_api_name: qiskit_aer
 
 ## Exceptions
 
-<span id="module-qiskit_aer" />
-
-`¶`
-
 |                                                                    |                                             |
 | ------------------------------------------------------------------ | ------------------------------------------- |
 | [`AerError`](qiskit_aer.AerError "qiskit_aer.AerError")(\*message) | Base class for errors raised by simulators. |

diff --git a/docs/api/qiskit/0.42/aer_pulse.md b/docs/api/qiskit/0.42/aer_pulse.md
@@ -14,26 +14,18 @@ python_api_name: qiskit_aer.pulse
 
 <span id="module-qiskit_aer.pulse" />
 
-`qiskit_aer.pulse¶`
+`qiskit_aer.pulse`
 
 This module contains classes and functions to build a pulse system model for simulating a Qiskit pulse schedule.
 
 ## Classes
 
-<span id="module-qiskit_aer.pulse" />
-
-`¶`
-
 |                                                                                                                  |                                            |
 | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
 | [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel")(\[hamiltonian, ...]) | Physical model object for pulse simulator. |
 
 ## Functions
 
-<span id="module-qiskit_aer.pulse" />
-
-`¶`
-
 These functions can be used to generate a pulse system model for certain types of systems.
 
 |                                                                                                                                |                                                                                                                                                                              |

diff --git a/docs/api/qiskit/0.42/aer_quantum_info.md b/docs/api/qiskit/0.42/aer_quantum_info.md
@@ -12,14 +12,10 @@ python_api_name: qiskit_aer.quantum_info
 
 <span id="module-qiskit_aer.quantum_info" />
 
-`qiskit_aer.quantum_info¶`
+`qiskit_aer.quantum_info`
 
 ## States
 
-<span id="module-qiskit_aer.quantum_info" />
-
-`¶`
-
 |                                                                                                                          |                                                             |
 | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
 | [`AerStatevector`](qiskit_aer.quantum_info.AerStatevector "qiskit_aer.quantum_info.AerStatevector")(data\[, dims])       | AerStatevector class                                        |

diff --git a/docs/api/qiskit/0.42/aer_utils.md b/docs/api/qiskit/0.42/aer_utils.md
@@ -14,16 +14,12 @@ python_api_name: qiskit_aer.utils
 
 <span id="module-qiskit_aer.utils" />
 
-`qiskit_aer.utils¶`
+`qiskit_aer.utils`
 
 This module contains utility functions for modifying [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") objects and `QuantumCircuits` using noise models.
 
 ## Functions
 
-<span id="module-qiskit_aer.utils" />
-
-`¶`
-
 |                                                                                                                                           |                                                                                                           |
 | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
 | [`insert_noise`](qiskit_aer.utils.insert_noise "qiskit_aer.utils.insert_noise")(circuits, noise\_model\[, transpile])                     | Return a noisy version of a QuantumCircuit.                                                               |