Merge pull request #60 from ColibrITD-SAS/feat-test-exemples

Feat: test exemples

Author: Henri-ColibrITD

.github/workflows/tests.yml

@@ -4,40 +4,57 @@ on:
   push:
     branches:
       - dev
+      - main
   workflow_dispatch:
     inputs:
       python_v:
-        description: 'python version'
+        description: "python version"
         required: true
-        default: '3.9'
+        default: "3.9"
         type: choice
         options:
-          - '3.9'
-          - '3.10'
-          - '3.11'
+          - "3.9"
+          - "3.10"
+          - "3.11"
       commit_ref:
         description: Specific ref (branch, tag or SHA)
-        default: ''
+        default: ""
         type: string
         required: false
-
+      long:
+        description: "Run long tests"
+        required: false
+        default: false
+        type: boolean
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Repository
+      - name: Checkout repository
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.commit_ref || github.ref }}
-      - name: Set up Python ${{ github.event.inputs.python_v || '3.9' }}
+      - name: Set up python ${{ github.event.inputs.python_v || '3.9' }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ github.event.inputs.python_v || '3.9' }}
           cache: "pip"
-      - name: Install Dependencies
+      - name: Install dependencies
         run: |
           pip install --upgrade pip
           pip install -r requirements-dev.txt
-      - name: Run test
-        run: python -m pytest
+      - name: Install long dedendencies
+        if: ${{ github.event.inputs.long == 'true' || github.ref_name == 'main' }}
+        run: |
+          pip install .
+          sudo apt-get update
+          sudo apt install -y poppler-utils
+          sudo apt-get install -y texlive-latex-base texlive-pictures texlive-latex-extra
+      - name: Run tests
+        run: |
+          if [ "${{ github.event.inputs.long }}" == "true" ] || [ "${{ github.ref_name }}" == "main" ]; then
+            python -m pytest --long-local
+          else
+            python -m pytest
+          fi

CONTRIBUTING.md

@@ -95,11 +95,12 @@ repository, and find the one you need to modify to achieve your goal.
 
 Here are some useful scripts for when you are developing:
 
-| Command                           | Description              |
-| --------------------------------- | ------------------------ |
-| `sphinx-build -b html docs build` | Builds the documentation |
-| `python -m pytest`                | Runs the test suite      |
-| `python -m pytest --long`         | Runs the long tests too  |
+| Command                           | Description               |
+| --------------------------------- | ------------------------- |
+| `sphinx-build -b html docs build` | Builds the documentation  |
+| `python -m pytest`                | Runs the test suite       |
+| `python -m pytest --long`         | Runs the long tests too   |
+| `python -m pytest --long-local`   | Runs the local long tests |
 
 When making commits, make sure to follow the
 [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)

conftest.py

@@ -1,13 +1,10 @@
-import os
-
-from pytest import Metafunc, Parser
+from pytest import Parser
 
 
 def pytest_addoption(parser: Parser):
     parser.addoption("--long", action="store_false", help="If set, long tests will run")
-
-
-def pytest_generate_tests(metafunc: Metafunc):
-    print("ho")
-    if metafunc.config.option.long:
-        os.environ["LONG_TESTS"] = "True"
+    parser.addoption(
+        "--long-local",
+        action="store_false",
+        help="If set, only local long tests will run",
+    )

examples/notebooks/1_Basics_of_circuit.ipynb

@@ -649,7 +649,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from mpqp.gates import symbols\n",
+    "from sympy import symbols\n",
     "\n",
     "theta, k = symbols(\"θ k\")"
    ]
@@ -790,7 +790,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.12"
+   "version": "3.9.5"
   }
  },
  "nbformat": 4,

examples/notebooks/4_Quantum_Fourier_Transform.ipynb

@@ -16,20 +16,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 2,
    "id": "0e19bebf",
    "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"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from mpqp.gates import *\n",
+    "from mpqp.execution.result import Result\n",
     "from mpqp import QCircuit, Barrier\n",
     "from mpqp.execution import run, IBMDevice\n",
     "from math import floor\n",
@@ -46,7 +39,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "ffdddefb",
    "metadata": {},
    "outputs": [],
@@ -60,12 +53,14 @@
     "        self._build()\n",
     "    \n",
     "    def _build(self):\n",
-    "        \n",
-    "        self.add([H(j),[CRk(i+1,i,j) for i in range(j+1,self.nb_qubits)],Barrier()] for j in range(0,self.nb_qubits))\n",
-    "        self.add([SWAP(i,self.nb_qubits-1-i) for i in range(0,int(floor(self.nb_qubits/2)))])\n",
+    "        for j in range(self.nb_qubits):\n",
+    "            self.add(H(j))\n",
+    "            self.add([CRk(i+1, i, j) for i in range(j+1, self.nb_qubits)])\n",
+    "            self.add(Barrier())\n",
+    "        self.add([SWAP(i, self.nb_qubits-1-i) for i in range(int(floor(self.nb_qubits / 2)))])\n",
     "        \n",
     "        if self.inverse == True:\n",
-    "           self.inverse() "
+    "           self.inverse()"
    ]
   },
   {
@@ -78,7 +73,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "f290c657",
    "metadata": {
     "scrolled": false
@@ -88,7 +83,6 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "hi\n",
       "     ┌───┐                                      ░                        »\n",
       "q_0: ┤ H ├─■────────■────────■────────■─────────░────────────────────────»\n",
       "     └───┘ │P(π/2)  │        │        │         ░ ┌───┐                  »\n",
@@ -133,7 +127,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "ce59b0f3",
    "metadata": {},
    "outputs": [
@@ -152,8 +146,9 @@
     }
    ],
    "source": [
-    "result = run(qft_5, [IBMDevice.AER_SIMULATOR_STATEVECTOR])\n",
-    "print(result.amplitudes)"
+    "result = run(qft_5, IBMDevice.AER_SIMULATOR_STATEVECTOR)\n",
+    "if isinstance(result, Result):\n",
+    "    print(result.amplitudes)"
    ]
   },
   {
@@ -166,15 +161,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "97f049b8",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "hi\n",
       "     ┌───┐          ░       ░    \n",
       "q_0: ┤ H ├─■────────░───────░──X─\n",
       "     ├───┤ │P(π/2)  ░ ┌───┐ ░  │ \n",
@@ -191,20 +185,20 @@
     "print(qc1)\n",
     "\n",
     "result1 = run(qc1, IBMDevice.AER_SIMULATOR_STATEVECTOR) \n",
-    "print(result1.amplitudes)"
+    "if isinstance(result1, Result):\n",
+    "    print(result1.amplitudes)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "id": "67e3e10a",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "hi\n",
       "     ┌────────────┐                        ┌───┐┌───┐                   ░      »\n",
       "q_0: ┤ Ry(1.9106) ├─■───────────────────■──┤ X ├┤ H ├─■────────■────────░──────»\n",
       "     └┬──────────┬┘ │ ┌─────────┐     ┌─┴─┐└───┘└───┘ │P(π/2)  │        ░ ┌───┐»\n",
@@ -233,7 +227,8 @@
     "print(qc2)\n",
     "\n",
     "result2 = run(qc2, IBMDevice.AER_SIMULATOR_STATEVECTOR)\n",
-    "print(result2.amplitudes)"
+    "if isinstance(result2, Result):\n",
+    "    print(result2.amplitudes)"
    ]
   }
  ],
@@ -253,7 +248,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.12"
+   "version": "3.9.5"
   }
  },
  "nbformat": 4,

examples/scripts/cirq_experiments.py

@@ -2,7 +2,6 @@
 from mpqp import QCircuit
 from mpqp.core.languages import Language
 from mpqp.execution import run
-from mpqp.execution.connection.key_connection import config_ionq_key
 from mpqp.execution.devices import GOOGLEDevice, IBMDevice
 from mpqp.gates import H, Rx, Ry, Rz
 from mpqp.measures import BasisMeasure
@@ -42,12 +41,3 @@
 processor_id = "rainbow"
 grid_circuit = circuit.to_other_language(Language.CIRQ, cirq_proc_id=processor_id)
 print(f"circuit for processor {processor_id}:\n{grid_circuit}\n")
-
-# %%
-config_ionq_key()
-
-# %%
-results = run(circuit, [GOOGLEDevice.IONQ_SIMULATOR])
-print(results)
-
-results.plot()

mpqp/core/circuit.py

@@ -74,14 +74,14 @@ class QCircuit:
     Examples:
         >>> circuit = QCircuit(2)
         >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
-        QCircuit : Size (Qubits,Cbits) = (2, 0), Nb instructions = 0
+        QCircuit : Size (Qubits, Cbit) = (2, 0), Nb instruction = 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
-        QCircuit Circuit 1: Size (Qubits,Cbits) = (5, 2), Nb instructions = 1
+        QCircuit Circuit 1: Size (Qubits, Cbits) = (5, 2), Nb instruction = 1
         q_0: ────────────
         q_1: ────────────
         q_2: ────────────
@@ -96,7 +96,7 @@ class QCircuit:
         >>> circuit.add(BasisMeasure(list(range(3)), shots=2345))
         >>> circuit.add(Depolarizing(prob=0.50, targets=[0, 1]))
         >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
-        QCircuit NoiseExample: Size (Qubits,Cbits) = (3, 3), Nb instructions = 5
+        QCircuit NoiseExample: Size (Qubits, Cbits) = (3, 3), Nb instructions = 5
         Depolarizing noise: probability 0.5 on qubits [0, 1]
              ┌───┐     ┌─┐
         q_0: ┤ H ├──■──┤M├───
@@ -163,7 +163,7 @@ def add(self, components: OneOrMany[Instruction | NoiseModel]):
             >>> circuit.add(X(0))
             >>> circuit.add([CNOT(0, 1), BasisMeasure([0, 1], shots=100)])
             >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
-            QCircuit : Size (Qubits,Cbits) = (2, 2), Nb instructions = 3
+            QCircuit : Size (Qubits, Cbits) = (2, 2), Nb instructions = 3
                  ┌───┐     ┌─┐
             q_0: ┤ X ├──■──┤M├───
                  └───┘┌─┴─┐└╥┘┌─┐
@@ -175,9 +175,9 @@ def add(self, components: OneOrMany[Instruction | NoiseModel]):
             >>> circuit.add(Depolarizing(0.3, [0,1], dimension=2, gates=[CNOT]))
             >>> circuit.add([Depolarizing(0.02, [0])])
             >>> circuit.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
-            QCircuit : Size (Qubits,Cbits) = (2, 2), Nb instructions = 3
-            Depolarizing noise: probability 0.3 for gates [CNOT]
-            Depolarizing noise: probability 0.02 on qubits [0]
+            QCircuit : Size (Qubits, Cbits) = (2, 2), Nb instructions = 3
+            Depolarizing noise: probability 0.3 for gate CNOT
+            Depolarizing noise: probability 0.02 on qubit 0
                  ┌───┐     ┌─┐
             q_0: ┤ X ├──■──┤M├───
                  └───┘┌─┴─┐└╥┘┌─┐
@@ -224,7 +224,7 @@ def add(self, components: OneOrMany[Instruction | NoiseModel]):
         if isinstance(components, NoiseModel):
             if len(components.targets) == 0:
                 components.targets = [target for target in range(self.nb_qubits)]
-                
+
             basisMs = [
                 instr for instr in self.instructions if isinstance(instr, BasisMeasure)
             ]
@@ -1038,7 +1038,7 @@ def pretty_print(self):
         Examples:
             >>> c = QCircuit([H(0), CNOT(0,1)])
             >>> c.pretty_print()  # doctest: +NORMALIZE_WHITESPACE
-            QCircuit : Size (Qubits,Cbits) = (2, 0), Nb instructions = 2
+            QCircuit : Size (Qubits, Cbit) = (2, 0), Nb instructions = 2
                  ┌───┐
             q_0: ┤ H ├──■──
                  └───┘┌─┴─┐
@@ -1047,7 +1047,7 @@ def pretty_print(self):
 
         """
         print(
-            f"QCircuit {self.label or ''}: Size (Qubits,Cbits) = {self.size()},"
+            f"QCircuit {self.label or ''}: Size (Qubits, Cbits) = {self.size()},"
             f" Nb instructions = {len(self)}"
         )
 
@@ -1061,9 +1061,15 @@ def pretty_print(self):
                 targets = set(noise.targets)
                 noise_info = f"{type(noise).__name__} noise: probability {noise.proba}"
                 if targets != qubits:
-                    noise_info += f" on qubits {noise.targets}"
+                    noise_info += (
+                        f" on qubit{'s' if len(noise.targets) > 1 else ''} "
+                        f"{noise.targets[0] if len(noise.targets) == 1 else noise.targets}"
+                    )
                 if noise.gates:
-                    noise_info += f" for gates {noise.gates}"
+                    noise_info += (
+                        f" for gate{'s' if len(noise.gates) > 1 else ''} "
+                        f"{noise.gates[0] if len(noise.gates) == 1 else noise.gates}"
+                    )
                 print(noise_info)
 
         print(f"{self.to_other_language(Language.QISKIT)}")