Merge pull request #117 from ColibrITD-SAS/dev

Version 0.3.1

Author: Henri-ColibrITD

docs/getting-started.rst

@@ -11,24 +11,52 @@ For now, we support Python versions 3.9 to 3.11, and all of Windows, Linux and
 MacOS (specifically, Linux was validated on Ubuntu LTS 20.04, while Ubuntu 18.04 
 is not supported, so your milage may vary).
 
+To install mpqp, you can run in a terminal
+
 .. code-block:: console
 
    $ pip install mpqp
 
+And if you have already a previous version and want to update to the latest
+version, run instead
+
+.. code-block:: console
+
+   $ pip install -U mpqp
+
 .. note::
     For Mac users, additional steps are required before installation, 
     specifically because of the ``myqlm`` library. To run these steps, you can 
     either follow their instructions on 
     `this page <https://myqlm.github.io/01_getting_started/%3Amyqlm%3Amacos.html#macos>`_
     or run the script we created to facilitate this step:
 
-    .. code-block:: bash
+    .. code-block:: console
 
-        curl -L https://raw.githubusercontent.com/ColibrITD-SAS/mpqp/main/mac-install.sh | bash -s -- <your-python-bin>
+        $ curl -L https://raw.githubusercontent.com/ColibrITD-SAS/mpqp/main/mac-install.sh | bash -s -- <your-python-bin>
         
     where ``<your-python-bin>`` is the binary you use to invoke python. For instance, it could
     be ``python``, ``python3``, or ``python3.9``.
 
+.. warning::
+    The migration from ``qiskit`` version ``0.x`` to ``1.x`` caused a few issues. 
+    In case you had a ``qiskit 0.x`` environment, you might encounter an error 
+    such as 
+    
+    .. code-block:: bash
+
+        ImportError: Qiskit is installed in an invalid environment that has both Qiskit >=1.0 and an earlier version...
+
+    To fix this, we provide a script you can run that will fix your environment.
+    In a terminal, simply run.
+
+    .. code-block:: console
+
+        $ update_qiskit
+
+    Alternatively, if you want to keep your old qiskit environment, you can also
+    create a new virtual environment.
+
 Your first circuit
 ------------------
 

mpqp/execution/providers/ibm.py

@@ -21,7 +21,6 @@
 from mpqp.execution.devices import AZUREDevice, IBMDevice
 from mpqp.execution.job import Job, JobStatus, JobType
 from mpqp.execution.result import Result, Sample, StateVector
-from mpqp.execution.simulated_devices import IBMSimulatedDevice
 from mpqp.noise import DimensionalNoiseModel
 from mpqp.tools.errors import DeviceJobIncompatibleError, IBMRemoteExecutionError
 
@@ -38,6 +37,7 @@
     from qiskit_aer import AerSimulator
     from qiskit_aer.noise import NoiseModel as Qiskit_NoiseModel
     from qiskit_ibm_runtime import RuntimeJobV2
+    from mpqp.execution.simulated_devices import IBMSimulatedDevice
 
 
 @typechecked
@@ -84,6 +84,7 @@ def compute_expectation_value(
         :func:`~mpqp.execution.runner.run` instead.
     """
     from qiskit.quantum_info import SparsePauliOp
+    from mpqp.execution.simulated_devices import IBMSimulatedDevice
 
     if not isinstance(job.measure, ExpectationMeasure):
         raise ValueError(
@@ -150,6 +151,8 @@ def check_job_compatibility(job: Job):
             contained in the job (measure and job_type, device and job_type,
             etc...).
     """
+    from mpqp.execution.simulated_devices import IBMSimulatedDevice
+
     if TYPE_CHECKING:
         assert isinstance(job.device, (IBMDevice, IBMSimulatedDevice))
 
@@ -413,6 +416,7 @@ def run_aer(job: Job):
 
     from qiskit import QuantumCircuit, transpile
     from qiskit_aer import AerSimulator
+    from mpqp.execution.simulated_devices import IBMSimulatedDevice
 
     job_circuit = job.circuit
 
@@ -582,7 +586,7 @@ def run_remote_ibm(job: Job) -> Result:
 def extract_result(
     result: "QiskitResult | EstimatorResult | PrimitiveResult[PubResult | SamplerPubResult]",
     job: Optional[Job],
-    device: IBMDevice | IBMSimulatedDevice | AZUREDevice,
+    device: "IBMDevice | IBMSimulatedDevice | AZUREDevice",
 ) -> Result:
     """Parses a result from ``IBM`` execution (remote or local) in a ``MPQP``
     :class:`~mpqp.execution.result.Result`.

mpqp/tools/circuit.py

@@ -39,8 +39,7 @@
     from qiskit.circuit.quantumcircuitdata import CircuitInstruction
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
+@typechecked
 def random_circuit(
     gate_classes: Optional[Sequence[type[Gate]]] = None,
     nb_qubits: int = 5,
@@ -85,7 +84,7 @@ def random_circuit(
     rng = np.random.default_rng(seed)
 
     if nb_gates is None:
-        nb_gates = rng.integers(5, 10)
+        nb_gates = int(rng.integers(5, 10))
 
     qcircuit = QCircuit(nb_qubits)
     for _ in range(nb_gates):

mpqp/tools/display.py

@@ -31,9 +31,8 @@ def state_vector_ket_shape(sv: npt.NDArray[np.complex64]) -> str:
     )[2:]
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
-def with_sign(val: np.complex64) -> str:
+@typechecked
+def with_sign(val: Union[np.complex64, np.complex128]) -> str:
     """Sometimes, we want values under a specific format, in particular
     ``<sign> <value>``. Where value is as simple as possible (*e.g.* no period
     or no imaginary part if there is no need).
@@ -57,18 +56,20 @@ def with_sign(val: np.complex64) -> str:
     return "+ " + str_rounded
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
-def _remove_null_imag(val: np.complex64) -> np.complex64 | np.float32 | int:
+@typechecked
+def _remove_null_imag(
+    val: np.complex64 | np.complex128,
+) -> np.complex64 | np.complex128 | np.float32 | int:
     val = np.round(val, 3)
     if val.imag != 0:
         return val
     return _remove_unnecessary_decimals(val.real)
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
-def _remove_unnecessary_decimals(val: np.float32 | int) -> np.float32 | int:
+@typechecked
+def _remove_unnecessary_decimals(
+    val: np.float32 | np.float64 | int,
+) -> np.float32 | int:
     val = np.float32(val)
     if val.is_integer():
         return int(val)
@@ -190,9 +191,8 @@ def clean_1D_array(
     )
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
-def clean_number_repr(number: complex, round: int = 7):
+@typechecked
+def clean_number_repr(number: Union[complex, np.complex64], round: int = 7):
     """Cleans and formats a number. This function rounds the parts of
     complex numbers and formats them as integers if appropriate. It returns a
     string representation of the number.
@@ -234,8 +234,7 @@ def clean_number_repr(number: complex, round: int = 7):
     return f"{str(real_part)}{str(imag_part)}"
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
+@typechecked
 def clean_matrix(matrix: Matrix, round: int = 5, align: bool = True):
     """Cleans and formats elements of a 2D matrix. This function rounds the
     parts of the numbers in the matrix and formats them as integers if
@@ -250,9 +249,9 @@ def clean_matrix(matrix: Matrix, round: int = 5, align: bool = True):
         A string representation of the cleaned matrix.
 
     Examples:
-        >>> print(clean_matrix([[1.234567895546, 2.3456789645645, 3.45678945645],
-        ...                     [1+5j, 0+1j, 5.],
-        ...                     [1.223123425+0.95113462364j, 2.0, 3.0]]))
+        >>> print(clean_matrix(np.array([[1.234567895546, 2.3456789645645, 3.45678945645],
+        ... [1+5j, 0+1j, 5.],
+        ... [1.223123425+0.95113462364j, 2.0, 3.0]])))
         [[1.23457         , 2.34568, 3.45679],
          [1+5j            , 1j     , 5      ],
          [1.22312+0.95113j, 2      , 3      ]]
@@ -280,8 +279,7 @@ def clean_matrix(matrix: Matrix, round: int = 5, align: bool = True):
     )
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
+@typechecked
 def pprint(matrix: Matrix, round: int = 5, align: bool = True):
     """Print a cleans and formats elements of a matrix. It rounds the real parts of complex numbers
     in the matrix places and formats them as integers if they are whole numbers. It returns a
@@ -293,9 +291,9 @@ def pprint(matrix: Matrix, round: int = 5, align: bool = True):
         align: Whether to align the elements for a cleaner output.
 
     Example:
-        >>> pprint([[1.234567895546, 2.3456789645645, 3.45678945645],
-        ...                     [1+5j, 0+1j, 5.],
-        ...                     [1.223123425+0.95113462364j, 2.0, 3.0]])
+        >>> pprint(np.array([[1.234567895546, 2.3456789645645, 3.45678945645],
+        ... [1+5j, 0+1j, 5.],
+        ... [1.223123425+0.95113462364j, 2.0, 3.0]]))
         [[1.23457         , 2.34568, 3.45679],
          [1+5j            , 1j     , 5      ],
          [1.22312+0.95113j, 2      , 3      ]]

mpqp/tools/theoretical_simulation.py

@@ -216,8 +216,7 @@ def exp_id_dist(
     return float(jensenshannon(mpqp_counts, noisy_probs * sum(mpqp_counts)))
 
 
-# @typechecked
-# FIXME: Resolve type-checking errors encountered during test execution.
+@typechecked
 def validate_noisy_circuit(
     circuit: QCircuit,
     shots: int = 1024,
@@ -233,7 +232,7 @@ def validate_noisy_circuit(
     Returns:
         Weather our noise pipeline matches the theory or not.
     """
-    return exp_id_dist(circuit, shots, device) <= trust_int(circuit)
+    return bool(exp_id_dist(circuit, shots, device) <= trust_int(circuit))
 
 
 @typechecked

mpqp_scripts/update_qiskit.py

@@ -0,0 +1,42 @@
+import subprocess
+import sys
+
+qiskit_packages = [
+    "qiskit",
+    "qiskit-aer",
+    "qiskit-algorithms",
+    "qiskit_alice_bob_provider",
+    "qiskit-aqua",
+    "qiskit-finance",
+    "qiskit-ibm-provider",
+    "qiskit-ibm-runtime",
+    "qiskit-ibmq-provider",
+    "qiskit-ignis",
+    "qiskit-optimization",
+    "qiskit-qir-alice-bob-fork",
+    "qiskit-terra",
+    "ibm-cloud-sdk-core",
+    "ibm-platform-services",
+    "IBMQuantumExperience",
+]
+
+
+def run_command(command: str):
+    """Run a shell command and handle errors."""
+    result = subprocess.run(command, shell=True)
+    if result.returncode != 0:
+        print(f"Error running command: {command}")
+
+
+def update_packages():
+    """Uninstall all specified Qiskit packages."""
+    print(f"Uninstalling qiskit package...")
+    for pkg in qiskit_packages:
+        run_command(f"{sys.executable} -m pip uninstall -y {pkg}")
+    print("Installing mpqp...")
+    run_command(f"{sys.executable} -m pip install --upgrade mpqp")
+
+
+if __name__ == "__main__":
+    print(f"Using Python executable: {sys.executable}")
+    update_packages()

setup.py

@@ -33,6 +33,7 @@
     entry_points={
         "console_scripts": [
             "setup_connections = mpqp_scripts.setup_connections:main_setup",
+            "update_qiskit = mpqp_scripts.update_qiskit:update_packages",
         ]
     },
     project_urls={