doc: integration in pytest

+ sphinx gen OK
+ doc examples improved/fixed

Author: Henri-ColibrITD

docs/examples.rst

@@ -12,5 +12,4 @@ On this page, you will find a few notebooks we provide as examples for various
    notebooks/2_Execution_Bell_circuit
    notebooks/3_Expectation_value_of_observables
    notebooks/4_Quantum_Fourier_Transform
-   notebooks/5_Variational_Quantum_Algorithms
-   notebooks/6_Pauli_string_observable
+   notebooks/5_Variational_Quantum_Algorithms

docs/notebooks/6_Pauli_string_observable.nblink

@@ -70,13 +70,13 @@ class QCircuit:
 
     Example:
         >>> circuit = QCircuit(2)
-        >>> circuit.pretty_print() # doctest: +NORMALIZE_WHITESPACE
+        >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
         QCircuit : Size (Qubits,Cbits) = (2, 0), Nb instructions = 0
         q_0:
         q_1:
         >>> circuit = QCircuit(5, nb_cbits=2, label="Circuit 1")
         >>> circuit.add(Rx(1.23, 3))
-        >>> circuit.pretty_print() # doctest: +NORMALIZE_WHITESPACE
+        >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
         QCircuit Circuit 1: Size (Qubits,Cbits) = (5, 2), Nb instructions = 1
         q_0: ────────────
         q_1: ────────────
@@ -137,7 +137,7 @@ def add(self, instruction: Instruction | Iterable[Instruction]):
             >>> circuit = QCircuit(2)
             >>> circuit.add(X(0))
             >>> circuit.add([CNOT(0, 1), BasisMeasure([0, 1], shots=100)])
-            >>> circuit.pretty_print() # doctest: +NORMALIZE_WHITESPACE
+            >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
             QCircuit : Size (Qubits,Cbits) = (2, 2), Nb instructions = 3
                  ┌───┐     ┌─┐
             q_0: ┤ X ├──■──┤M├───
@@ -202,7 +202,7 @@ def append(self, other: QCircuit, qubits_offset: int = 0) -> None:
             >>> c1 = QCircuit([CNOT(0,1),CNOT(1,2)])
             >>> c2 = QCircuit([X(1),CNOT(1,2)])
             >>> c1.append(c2)
-            >>> print(c1) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c1)  # doctest: +NORMALIZE_WHITESPACE
             q_0: ──■─────────────────
                  ┌─┴─┐     ┌───┐
             q_1: ┤ X ├──■──┤ X ├──■──
@@ -260,7 +260,7 @@ def tensor(self, other: QCircuit) -> QCircuit:
         Example:
             >>> c1 = QCircuit([CNOT(0,1),CNOT(1,2)])
             >>> c2 = QCircuit([X(1),CNOT(1,2)])
-            >>> print(c1.tensor(c2)) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c1.tensor(c2))  # doctest: +NORMALIZE_WHITESPACE
             q_0: ──■───────
                  ┌─┴─┐
             q_1: ┤ X ├──■──
@@ -304,7 +304,7 @@ def display(self, output: str = "mpl"):
                ┌──────┐
             q: ┤ P(θ) ├
                └──────┘
-            >>> print(circ.display("latex_source")) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(circ.display("latex_source"))  # doctest: +NORMALIZE_WHITESPACE
             \documentclass[border=2px]{standalone}
             \usepackage[braket, qm]{qcircuit}
             \usepackage{graphicx}
@@ -476,26 +476,26 @@ def inverse(self) -> QCircuit:
 
         Examples:
             >>> c1 = QCircuit([H(0), CNOT(0,1)])
-            >>> print(c1) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c1)  # doctest: +NORMALIZE_WHITESPACE
                  ┌───┐
             q_0: ┤ H ├──■──
                  └───┘┌─┴─┐
             q_1: ─────┤ X ├
                       └───┘
-            >>> print(c1.inverse()) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c1.inverse())  # doctest: +NORMALIZE_WHITESPACE
                       ┌───┐
             q_0: ──■──┤ H ├
                  ┌─┴─┐└───┘
             q_1: ┤ X ├─────
                  └───┘
             >>> c2 = QCircuit([S(0), CZ(0,1), H(1), Ry(4.56, 1)])
-            >>> print(c2) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c2)  # doctest: +NORMALIZE_WHITESPACE
                  ┌───┐
             q_0: ┤ S ├─■──────────────────
                  └───┘ │ ┌───┐┌──────────┐
             q_1: ──────■─┤ H ├┤ Ry(4.56) ├
                          └───┘└──────────┘
-            >>> print(c2.inverse()) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c2.inverse())  # doctest: +NORMALIZE_WHITESPACE
                                      ┌───┐
             q_0: ──────────────────■─┤ S ├
                  ┌──────────┐┌───┐ │ └───┘
@@ -544,7 +544,7 @@ def initializer(cls, state: npt.NDArray[np.complex64]) -> QCircuit:
 
         Examples:
             >>> qc = QCircuit.initializer(np.array([1, 0, 0 ,1])/np.sqrt(2))
-            >>> print(qc) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(qc)  # doctest: +NORMALIZE_WHITESPACE
                  ┌───┐
             q_0: ┤ H ├──■──
                  └───┘┌─┴─┐
@@ -600,8 +600,9 @@ def get_measurements(self) -> list[Measure]:
             ...     BasisMeasure([0, 1], shots=1000),
             ...     ExpectationMeasure([1], Observable(np.identity(2)), shots=1000)
             ... ])
-            >>> circuit.get_measurements()
-            [BasisMeasure([0, 1], shots=1000), ExpectationMeasure([1], Observable(array([[1.+0.j, 0.+0.j], [0.+0.j, 1.+0.j]], dtype=complex64)), shots=1000)]
+            >>> circuit.get_measurements()  # doctest: +NORMALIZE_WHITESPACE
+            [BasisMeasure([0, 1], shots=1000),
+            ExpectationMeasure([1], Observable(array([[1.+0.j, 0.+0.j], [0.+0.j, 1.+0.j]], dtype=complex64)), shots=1000)]
 
         """
         return [inst for inst in self.instructions if isinstance(inst, Measure)]
@@ -614,15 +615,15 @@ def without_measurements(self) -> QCircuit:
 
         Example:
             >>> circuit = QCircuit([X(0), CNOT(0, 1), BasisMeasure([0, 1], shots=100)])
-            >>> print(circuit) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(circuit)  # doctest: +NORMALIZE_WHITESPACE
                  ┌───┐     ┌─┐
             q_0: ┤ X ├──■──┤M├───
                  └───┘┌─┴─┐└╥┘┌─┐
             q_1: ─────┤ X ├─╫─┤M├
                       └───┘ ║ └╥┘
             c: 2/═══════════╩══╩═
                             0  1
-            >>> print(circuit.without_measurements()) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(circuit.without_measurements())  # doctest: +NORMALIZE_WHITESPACE
                  ┌───┐
             q_0: ┤ X ├──■──
                  └───┘┌─┴─┐
@@ -760,13 +761,13 @@ def to_other_language(
                 from cirq.transformers.optimize_for_target_gateset import (
                     optimize_for_target_gateset,
                 )
-                from cirq_google.engine.virtual_engine_factory import (
-                    create_device_from_processor_id,
-                )
                 from cirq.transformers.routing.route_circuit_cqc import RouteCQC
                 from cirq.transformers.target_gatesets.sqrt_iswap_gateset import (
                     SqrtIswapTargetGateset,
                 )
+                from cirq_google.engine.virtual_engine_factory import (
+                    create_device_from_processor_id,
+                )
 
                 device = create_device_from_processor_id(cirq_proc_id)
                 if device.metadata is None:
@@ -798,7 +799,7 @@ def to_qasm2(self) -> str:
 
         Example:
             >>> circuit = QCircuit([X(0), CNOT(0, 1), BasisMeasure([0, 1], shots=100)])
-            >>> print(circuit.to_qasm2()) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(circuit.to_qasm2())  # doctest: +NORMALIZE_WHITESPACE
             OPENQASM 2.0;
             include "qelib1.inc";
             qreg q[2];
@@ -830,7 +831,7 @@ def to_qasm3(self) -> str:
 
         Example:
             >>> circuit = QCircuit([X(0), CNOT(0, 1), BasisMeasure([0, 1], shots=100)])
-            >>> print(circuit.to_qasm3()) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(circuit.to_qasm3())  # doctest: +NORMALIZE_WHITESPACE
             OPENQASM 3.0;
             include "stdgates.inc";
             qubit[2] q;
@@ -869,7 +870,7 @@ def subs(
             ...     [Rx(theta, 0), CNOT(1,0), CNOT(1,2), X(2), Rk(2,1), H(0), CRk(k, 0, 1),
             ...      BasisMeasure(list(range(3)), shots=1000)]
             ... )
-            >>> print(c) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c)  # doctest: +NORMALIZE_WHITESPACE
                  ┌───────┐┌───┐┌───┐                              ┌─┐
             q_0: ┤ Rx(θ) ├┤ X ├┤ H ├────────────■─────────────────┤M├───
                  └───────┘└─┬─┘└───┘┌─────────┐ │P(2**(1 - k)*pi) └╥┘┌─┐
@@ -879,7 +880,7 @@ def subs(
                                └───┘   └───┘           └╥┘         ║  ║
             c: 3/═══════════════════════════════════════╩══════════╩══╩═
                                                         2          0  1
-            >>> print(c.subs({theta: np.pi, k: 1})) # doctest: +NORMALIZE_WHITESPACE
+            >>> print(c.subs({theta: np.pi, k: 1}))  # doctest: +NORMALIZE_WHITESPACE
                  ┌───────┐┌───┐┌───┐                 ┌─┐
             q_0: ┤ Rx(π) ├┤ X ├┤ H ├───────────■─────┤M├───
                  └───────┘└─┬─┘└───┘┌────────┐ │P(π) └╥┘┌─┐
@@ -903,7 +904,7 @@ def pretty_print(self):
 
         Example:
             >>> c = QCircuit([H(0), CNOT(0,1)])
-            >>> c.pretty_print() # doctest: +NORMALIZE_WHITESPACE
+            >>> c.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
             QCircuit : Size (Qubits,Cbits) = (2, 0), Nb instructions = 2
                  ┌───┐
             q_0: ┤ H ├──■──
@@ -943,7 +944,7 @@ def variables(self) -> set[Basic]:
             ...     Rx(theta, 0), CNOT(1,0), CNOT(1,2), X(2), Rk(2,1),
             ...     H(0), CRk(k, 0, 1), ExpectationMeasure([1], obs)
             ... ])
-            >>> circ.variables() # doctest: +SKIP
+            >>> circ.variables()  # doctest: +SKIP
             {θ, k}
 
         """

mpqp/core/circuit.py

@@ -182,8 +182,8 @@ def get_region(self) -> str:
         Examples:
             >>> AWSDevice.BRAKET_IONQ_HARMONY.get_region()
             'us-east-1'
-            >>> AWSDevice.BRAKET_SV1_SIMULATOR.get_region()
-            ''
+            >>> AWSDevice.BRAKET_SV1_SIMULATOR.get_region() == get_env_variable("AWS_DEFAULT_REGION")
+            True
             >>> AWSDevice.BRAKET_RIGETTI_ASPEN_M_3.get_region()
             'us-west-1'
 

mpqp/execution/devices.py

@@ -43,7 +43,7 @@ def get_remote_result(
           State: 000, Index: 0, Count: 1017, Probability: 0.5085
           State: 100, Index: 4, Count: 983, Probability: 0.4915
          Error: 0.011181519941139355
-        >>> print(remote_result_from_id(
+        >>> print(get_remote_result(
         ...     'cm80pb1054sir2ck9i3g',
         ...     IBMDevice.IBMQ_QASM_SIMULATOR,
         ... ))

mpqp/execution/remote_handler.py

@@ -23,7 +23,7 @@
 
 import math
 from numbers import Complex
-from typing import Any, Optional
+from typing import Optional
 
 import numpy as np
 import numpy.typing as npt
@@ -49,7 +49,7 @@ class StateVector:
         >>> state_vector = StateVector(np.array([1, 1, 1, -1])/2, 2)
         >>> state_vector.probabilities
         array([0.25, 0.25, 0.25, 0.25])
-        >>> print(state_vector) # doctest: +NORMALIZE_WHITESPACE
+        >>> print(state_vector)
          State vector: [0.5, 0.5, 0.5, -0.5]
          Probabilities: [0.25, 0.25, 0.25, 0.25]
          Number of qubits: 2
@@ -84,8 +84,7 @@ def amplitudes(self):
     def __str__(self):
         return f""" State vector: {clean_array(self.vector)}
  Probabilities: {clean_array(self.probabilities)}
- Number of qubits: {self.nb_qubits}
-"""
+ Number of qubits: {self.nb_qubits}"""
 
 
 @typechecked
@@ -378,17 +377,15 @@ def __str__(self):
  Probabilities: {clean_array(self.probabilities)}
  Samples:
 {samples_str}
- Error: {self.error}
-"""
+ Error: {self.error}"""
 
         if self.job.job_type == JobType.STATE_VECTOR:
             return header + "\n" + str(self.state_vector)
 
         if self.job.job_type == JobType.OBSERVABLE:
             return f"""{header}
  Expectation value: {self.expectation_value}
- Error/Variance: {self.error}
-"""
+ Error/Variance: {self.error}"""
 
         raise NotImplementedError(
             f"Job type {self.job.job_type} not implemented for __str__ method"
@@ -426,7 +423,7 @@ class BatchResult:
         ...     2048
         ... )
         >>> batch_result = BatchResult([result1, result2, result3])
-        >>> print(batch_result) # doctest: +NORMALIZE_WHITESPACE
+        >>> print(batch_result)
         BatchResult: 3 results
         Result: ATOSDevice, MYQLM_PYLINALG
          State vector: [0.5, 0.5, 0.5, -0.5]
@@ -442,7 +439,7 @@ class BatchResult:
         Result: ATOSDevice, MYQLM_PYLINALG
          Expectation value: -3.09834
          Error/Variance: 0.021
-        >>> print(batch_result[0]) # doctest: +NORMALIZE_WHITESPACE
+        >>> print(batch_result[0])
         Result: ATOSDevice, MYQLM_PYLINALG
          State vector: [0.5, 0.5, 0.5, -0.5]
          Probabilities: [0.25, 0.25, 0.25, 0.25]
@@ -456,7 +453,7 @@ def __init__(self, results: list[Result]):
 
     def __str__(self):
         header = f"BatchResult: {len(self.results)} results\n"
-        body = "".join(map(str, self.results))
+        body = "\n".join(map(str, self.results))
         return header + body
 
     def __repr__(self):

mpqp/execution/result.py

@@ -100,7 +100,7 @@ def find(iterable: Iterable[T], oracle: Callable[[T], bool]) -> T:
     raise ValueError("No objects satisfies the given oracle")
 
 
-def clean_array(array):  # type: ignore
+def clean_array(array: list[complex] | npt.NDArray[np.complex64 | np.float32]):
     """Cleans and formats elements of an array.
     This function rounds the real parts of complex numbers in the array to 7 decimal places
     and formats them as integers if they are whole numbers. It returns a string representation
@@ -165,6 +165,6 @@ def clean_matrix(matrix: Matrix):
          [1, 2, 3]]
 
     """
+    # TODO: add an option to align cols
     cleaned_matrix = [clean_array(row) for row in matrix]
-    return "[" +",\n ".join(cleaned_matrix) +"]"
-
+    return "[" + ",\n ".join(cleaned_matrix) + "]"