Merge branch 'dev' of https://github.com/ColibrITD-SAS/mpqp into dev

Author: JulienCalistoTD

examples/notebooks/3_Expectation_value_of_observables.ipynb

@@ -20,13 +20,6 @@
    "id": "a3c9a6e8",
    "metadata": {},
    "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "<frozen importlib._bootstrap>:228: RuntimeWarning: scipy._lib.messagestream.MessageStream size changed, may indicate binary incompatibility. Expected 56 from C header, got 64 from PyObject\n"
-     ]
-    },
     {
      "name": "stdout",
      "output_type": "stream",
@@ -167,11 +160,11 @@
      "text": [
       "BatchResult: 2 results\n",
       "Result: ATOSDevice, MYQLM_PYLINALG\n",
-      " Expectation value: -3.4769999999999994\n",
-      " Error/Variance: 0.10704925979198084\n",
+      " Expectation value: -3.6279999999999997\n",
+      " Error/Variance: 0.10472127540648739\n",
       "Result: IBMDevice, AER_SIMULATOR\n",
-      " Expectation value: -3.6155\n",
-      " Error/Variance: 22.003217250000002\n"
+      " Expectation value: -3.2729999999999992\n",
+      " Error/Variance: 22.060085000000004\n"
      ]
     }
    ],
@@ -192,7 +185,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 9,
    "id": "4ac9c7e0",
    "metadata": {},
    "outputs": [],
@@ -256,7 +249,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 10,
    "id": "bc5ed517",
    "metadata": {},
    "outputs": [
@@ -290,7 +283,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 11,
    "id": "06784ef3",
    "metadata": {},
    "outputs": [
@@ -299,7 +292,7 @@
      "output_type": "stream",
      "text": [
       "ps_2 = 1*I@Z + 2.555555555*Y@I + 1*X@Z + -1*X@Z\n",
-      "     = 1*I@Z + 2.555555555*Y@I\n",
+      "     = 2.555555555*Y@I + 1*I@Z\n",
       "    ~= 1*I@Z + 2.6*Y@I + 1*X@Z + -1*X@Z\n",
       "    ~= 1*I@Z + 2.5556*Y@I\n"
      ]
@@ -325,7 +318,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 12,
    "id": "b9cadb08",
    "metadata": {},
    "outputs": [
@@ -347,7 +340,6 @@
       "\n",
       "Tensor product:\n",
       "(1*I@Z + -3*X@Y) @ Z = 1*I@Z@Z + -3*X@Y@Z\n",
-      "\n",
       "(1*I@Z + -3*X@Y) @ (1*I@Z + 2.6*Y@I) = 1*I@Z@I@Z + -3*I@Z@X@Y + 2.6*Y@I@I@Z + -7.8*Y@I@X@Y\n"
      ]
     }
@@ -368,7 +360,6 @@
     "\n",
     "Tensor product:\n",
     "({ps_1}) @ Z = {ps_1@Z}\n",
-    "\n",
     "({ps_1}) @ ({ps_2}) = {ps_1@ps_2}\"\"\")"
    ]
   },
@@ -382,7 +373,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 13,
    "id": "5b0537a1",
    "metadata": {},
    "outputs": [],
@@ -402,7 +393,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 14,
    "id": "1732e099",
    "metadata": {},
    "outputs": [
@@ -422,12 +413,12 @@
       "\n",
       "`obs1` created with Pauli string:\n",
       "Pauli string:\n",
-      "1*I@X + -3*X@Y\n",
+      "1*I@Z + -3*X@Y\n",
       "matrix:\n",
-      "[[0.+0.j 1.+0.j 0.+0.j 0.-3.j]\n",
-      " [1.+0.j 0.+0.j 0.+3.j 0.+0.j]\n",
-      " [0.+0.j 0.-3.j 0.+0.j 1.+0.j]\n",
-      " [0.+3.j 0.+0.j 1.+0.j 0.+0.j]]\n"
+      "[[ 1.+0.j  0.+0.j  0.+0.j  0.-3.j]\n",
+      " [ 0.+0.j -1.+0.j  0.+3.j  0.+0.j]\n",
+      " [ 0.+0.j  0.-3.j  1.+0.j  0.+0.j]\n",
+      " [ 0.+3.j  0.+0.j  0.+0.j -1.+0.j]]\n"
      ]
     }
    ],
@@ -458,7 +449,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 15,
    "id": "892f0b6e",
    "metadata": {},
    "outputs": [],
@@ -469,7 +460,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 16,
    "id": "745aa999",
    "metadata": {},
    "outputs": [
@@ -478,16 +469,15 @@
      "output_type": "stream",
      "text": [
       "BatchResult: 3 results\n",
-      "Result: IBMDevice, AER_SIMULATOR\n",
-      " Expectation value: 0.08399999999999999\n",
-      " Error/Variance: 9.98776\n",
-      "Result: ATOSDevice, MYQLM_PYLINALG\n",
-      " Expectation value: 0.010000000000000009\n",
-      " Error/Variance: 0.10000486474653607\n",
       "Result: ATOSDevice, MYQLM_CLINALG\n",
-      " Expectation value: -0.017999999999999933\n",
-      " Error/Variance: 0.10001671531970716\n",
-      "\n"
+      " Expectation value: 0.08200000000000007\n",
+      " Error/Variance: 0.10000294289963965\n",
+      "Result: ATOSDevice, MYQLM_PYLINALG\n",
+      " Expectation value: 0.12600000000000006\n",
+      " Error/Variance: 0.10000590573151757\n",
+      "Result: IBMDevice, AER_SIMULATOR\n",
+      " Expectation value: 0.14800000000000002\n",
+      " Error/Variance: 9.987479999999998\n"
      ]
     }
    ],

examples/notebooks/6_Noise_Simulation.ipynb

@@ -20,7 +20,7 @@
     "from mpqp import QCircuit, Language\n",
     "from mpqp.gates import *\n",
     "from mpqp.noise import Depolarizing\n",
-    "from mpqp.measures import *\n",
+    "from mpqp.measures import BasisMeasure\n",
     "from mpqp.execution import *"
    ]
   },
@@ -441,7 +441,7 @@
    ],
    "source": [
     "for device in AWSDevice:\n",
-    "    print(device.name, \"|\", device.is_noisy_simulator() )"
+    "    print(device.name, \"|\", device.is_noisy_simulator())"
    ]
   },
   {

mpqp/core/instruction/measurement/pauli_string.py

@@ -458,14 +458,16 @@ class PauliStringAtom(PauliStringMonomial):
     """Represents a single Pauli operator acting on a qubit in a Pauli string.
 
     Args:
-        label: The label representing the Pauli operator (e.g., 'I', 'X', 'Y', 'Z').
+        label: The label representing the Pauli operator.
         matrix: The matrix representation of the Pauli operator.
 
     Raises:
-        AttributeError: new atoms cannot be created
+        RuntimeError: New atoms cannot be created, you should use the available
+            ones.
 
     Note:
-        All the atoms are already initialized. Available atoms are ('I', 'X', 'Y', 'Z').
+        All the atoms are already initialized. Available atoms are (``I``,
+        ``X``, ``Y``, ``Z``).
     """
 
     __is_mutable = True
@@ -476,8 +478,9 @@ def __init__(self, label: str, matrix: npt.NDArray[np.complex64]):
             self.matrix = matrix
             self.__is_mutable = False
         else:
-            raise AttributeError(
-                "New atoms cannot be created, just use the given I, X, Y and Z"
+            raise RuntimeError(
+                "New atoms cannot be created, just use the given `I`, `X`, `Y` "
+                "and `Z`"
             )
 
     @property

mpqp/execution/connection/ibm_connection.py

@@ -25,7 +25,7 @@ def config_ibm_account(token: str):
         token: IBM Quantum API token.
 
     Raises:
-        IBMRemoteExecutionError
+        IBMRemoteExecutionError: If the account could not be saved.
     """
     from qiskit_ibm_provider import IBMProvider
 
@@ -95,7 +95,8 @@ def get_IBMProvider() -> "IBMProvider":
     execution.
 
     Raises:
-        IBMRemoteExecutionError
+        IBMRemoteExecutionError: In the account was not properly configured
+            previously.
 
     Example:
         >>> instance = get_IBMProvider()
@@ -124,13 +125,13 @@ def get_IBMProvider() -> "IBMProvider":
             Ibm_Provider = IBMProvider()
         except RequestsApiError as err:
             raise IBMRemoteExecutionError(
-                "Error when instantiating IBM Provider (probably wrong token saved "
-                "in the account).\nTrace: " + str(err)
+                "Error when instantiating IBM Provider (probably wrong token "
+                "saved in the account).\nTrace: " + str(err)
             )
         except AccountNotFoundError as err:
             raise IBMRemoteExecutionError(
-                "Error when instantiating IBM Provider. No IBM Q account configured.\nTrace: "
-                + str(err)
+                "Error when instantiating IBM Provider. No IBM Q account "
+                "configured.\nTrace: " + str(err)
             )
     return Ibm_Provider
 

mpqp/execution/connection/qlm_connection.py

@@ -28,7 +28,7 @@ def config_qlm_account(username: str, password: str, global_config: bool) -> boo
             outside MPQP.
 
     Raises:
-        QLMRemoteExecutionError
+        QLMRemoteExecutionError: If the account could not be saved.
     """
     # store the username and password in environment variables QLM_USER and QLM_PASSWD in .mpqp
     prev_user = get_env_variable("QLM_USER")

mpqp/execution/devices.py

@@ -169,7 +169,8 @@ def from_str_remote(name: str):
             name: A string containing the name of the device.
 
         Raises:
-            ValueError
+            ValueError: If no device corresponding to the given name could be
+                found.
 
         Examples:
             >>> ATOSDevice.from_str_remote('NoisyQProc')

mpqp/execution/vqa/__init__.py

@@ -1,4 +1,5 @@
 # pyright: reportUnusedImport=false
-from .vqa import minimize
-from .optimizer import Optimizer
 from sympy import symbols
+
+from .optimizer import Optimizer
+from .vqa import minimize