Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/qiskit/dev/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,6 @@ Other:

* [Compilation Routines (`qiskit.compiler`)](compiler)
* [Top-level exceptions (`qiskit.exceptions`)](exceptions)
* [Root namespace (`qiskit`)](root)
* [Utilities (`qiskit.utils`)](utils)

2 changes: 1 addition & 1 deletion docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate

* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`.
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`.
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored.

**Returns**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ python_api_name: qiskit.circuit.library.MCXGate

* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`.
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`.
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored.

**Returns**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ $$

* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`.
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – A label for the resulting Pauli evolution gate, to display in visualizations. Per default, the label is set to `exp(-it <operators>)` where `<operators>` is the sum of the Paulis. Note that the label does not include any coefficients of the Paulis. See the class docstring for an example.
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`.
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`.
* **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored.

**Returns**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ $$

* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`.
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`.
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored.

**Returns**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ $$

* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`.
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`.
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`
* **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored.

**Returns**
Expand Down
16 changes: 16 additions & 0 deletions docs/api/qiskit/dev/qiskit.quantum_info.PauliLindbladMap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,22 @@ $$
Calculate the $\gamma$ for the map.
</Function>

### generators

<Function id="qiskit.quantum_info.PauliLindbladMap.generators" signature="generators()">
Get the generators of the map.

This is an alias for [`get_qubit_sparse_pauli_list_copy()`](#qiskit.quantum_info.PauliLindbladMap.get_qubit_sparse_pauli_list_copy "qiskit.quantum_info.PauliLindbladMap.get_qubit_sparse_pauli_list_copy"), providing a more convenient name that aligns with the naming conventions used in Aer and Runtime for similar classes.

**Returns**

A copy of the map’s generator terms.

**Return type**

[QubitSparsePauliList](qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList")
</Function>

### get\_qubit\_sparse\_pauli\_list\_copy

<Function id="qiskit.quantum_info.PauliLindbladMap.get_qubit_sparse_pauli_list_copy" signature="get_qubit_sparse_pauli_list_copy()">
Expand Down
37 changes: 37 additions & 0 deletions docs/api/qiskit/dev/root.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<span id="root-namespace-qiskit" />

<span id="qiskit-root" />

# Root namespace ([`qiskit`](index#module-qiskit "qiskit"))

Most Qiskit functionality is accessed through specific submodules. You can consult the top-level documentation of [`qiskit`](index#module-qiskit "qiskit") to find the list of modules, such as [`qiskit.circuit`](circuit#module-qiskit.circuit "qiskit.circuit") or [`qiskit.transpiler.passes`](transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes").

Several names are re-exported from the repository root, whose canonical public locations are in submodules. The re-exports in the root namespace are part of Qiskit’s public API.

Names re-exported from [`qiskit.circuit`](circuit#module-qiskit.circuit "qiskit.circuit"):

| | |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| [`AncillaRegister`](circuit#qiskit.circuit.AncillaRegister "qiskit.circuit.AncillaRegister")(\[size, name, bits]) | Implement an ancilla register. |
| [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")(\[size, name, bits]) | Implement a register. |
| [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")(\*regs\[, name, global\_phase, ...]) | Core Qiskit representation of a quantum circuit. |
| [`QuantumRegister`](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")(\[size, name, bits]) | Implement a register. |

Names re-exported from [`qiskit.compiler`](compiler#module-qiskit.compiler "qiskit.compiler"):

| | |
| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`transpile`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile")(circuits\[, backend, basis\_gates, ...]) | Transpile one or more circuits, according to some desired transpilation targets. |

Names re-exported from [`qiskit.exceptions`](exceptions#module-qiskit.exceptions "qiskit.exceptions"):

| | |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [`MissingOptionalLibraryError`](exceptions#qiskit.exceptions.MissingOptionalLibraryError "qiskit.exceptions.MissingOptionalLibraryError")(libname, name\[, ...]) | Raised when an optional library is missing. |
| [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError")(\*message) | Base class for errors raised by Qiskit. |

Names re-exported from [`qiskit.transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler"):

| | |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| [`generate_preset_pass_manager`](qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager")(\[...]) | Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") |
Binary file modified public/docs/api/qiskit/dev/objects.inv
Binary file not shown.
Binary file modified public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif
Binary file not shown.
Binary file modified public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif
Binary file not shown.
Binary file not shown.
Binary file modified public/docs/images/api/qiskit/dev/circuit_random-1.avif
Binary file not shown.
Binary file modified public/docs/images/api/qiskit/dev/circuit_random-3.avif
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified public/docs/images/api/qiskit/dev/transpiler-10.avif
Binary file not shown.
Binary file modified public/docs/images/api/qiskit/dev/transpiler-9.avif
Binary file not shown.
Binary file modified public/docs/images/api/qiskit/dev/visualization-1.avif
Binary file not shown.
Binary file modified public/docs/images/api/qiskit/dev/visualization-3.avif
Binary file not shown.
4 changes: 2 additions & 2 deletions scripts/config/api-html-artifacts.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"qiskit": {
"dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/5218013247/zip",
"dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/5285603325/zip",
"2.3": "https://ibm.box.com/shared/static/hu6gvj4857vb5sew5k98rr9yd7pxasqy.zip",
"2.2": "https://ibm.box.com/shared/static/c1lktwwwo9zu4z5wxqg1xs9fj57oeoco.zip",
"2.1": "https://ibm.box.com/shared/static/mplc0lvu7mi2xwri9z3y0u0lr6z9ivwv.zip",
Expand Down Expand Up @@ -35,7 +35,7 @@
"0.19": "https://ibm.box.com/shared/static/wjoea4x5tnxd0l4lgo2v3kxnx6btxvvl.zip"
},
"qiskit-ibm-runtime": {
"dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/5208052291/zip",
"dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/5230621787/zip",
"0.45": "https://ibm.box.com/shared/static/5o5rt86cc2ehvxmslleecat3iyob8igu.zip",
"0.44": "https://ibm.box.com/shared/static/o00e7wxcslox4vq3z0rz35093y40sfko.zip",
"0.43": "https://ibm.box.com/shared/static/nlpyvweh4n0xhuvl08p8zpykkkchgi2a.zip",
Expand Down
3 changes: 2 additions & 1 deletion scripts/config/historical-pages-to-latest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,8 @@
"qiskit.primitives.ObservableLike": "/",
"qiskit.primitives.ObservablesArray": "/",
"qiskit.primitives.ParameterLike": "/",
"qiskit.primitives.SamplerPub": "/"
"qiskit.primitives.SamplerPub": "/",
"root": "/"
}
},
"qiskit-ibm-runtime": {
Expand Down
Loading