Merge pull request #62 from ColibrITD-SAS/dev

New minor version, with it's flow of buxfixes

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

@@ -18,7 +18,7 @@ describing the problem you would like to solve.
 
 ### Setup your environment locally
 
-_Some commands will assume you have the GitHub CLI installed, if you haven't,
+\_Some commands will assume you have the GitHub CLI installed, if you haven't,
 consider [installing it](https://github.com/cli/cli#installation), but you can
 always use the Web UI if you prefer that instead.
 
@@ -41,6 +41,13 @@ etc... included), use pip:
 pip install -r requirements-dev.txt
 ```
 
+In the documentation, some notebooks are rendered to HTML, this process is done
+using [Pandoc](https://pandoc.org/). Unfortunately, this software cannot be
+installed from the pip repository, so you need to install it separately. You can
+check [their documentation](https://pandoc.org/installing.html) to see how to
+install it on your OS (you can find it on most package manager: `apt`,
+`yum`, `pacman`, `choco`, `winget`, `brew` and more... )
+
 The last (optinal) step is to setup a GitHub personal access tokens to enable
 the sphinx automatic changelog generation. This step is only important if you
 want to preview this changelog generation on your personal computer. Not being
@@ -88,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/)
@@ -117,8 +125,8 @@ following (even though each of these sections is optional):
 2. `Returns`
 3. `Raises`
 4. `Example(s)`
-5. `Notes`
-6. `Warnings`
+5. `Note`
+6. `Warning`
 
 ### When you're done
 

Dockerfile

@@ -9,9 +9,9 @@ RUN pip3 install --upgrade pip && \
 
 FROM python:3.9
 
-RUN apt-get update && \
-    apt-get install -y pandoc && \
-    apt-get clean && \
+RUN apt update && \
+    apt install -y pandoc && \
+    apt clean && \
     rm -rf /var/lib/apt/lists/*
 
 WORKDIR /usr/src/app/mpqp

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",
+    )

docs/_static/custom.css

@@ -29,6 +29,9 @@ div.document {
 } */
 
 /* *** fix for rtd dark *** */
+html[data-theme="dark"] .theme-switcher {
+  box-shadow: 0px 1px 14px 2px rgb(255 255 255 / 20%);
+}
 
 html[data-theme="dark"] div.nboutput.container div.output_area.stderr {
   background: rgb(103, 23, 23);
@@ -159,3 +162,50 @@ html[data-theme="dark"] .rst-content .admonition,
 html[data-theme="dark"] .rst-content .note {
     background-color: #80cb53;
 }*/
+
+.highlight-python.import {
+  position: sticky;
+  top: 10px;
+  z-index: 9999;
+  box-shadow: 0px 0px 10px 0px black;
+}
+
+html[data-theme="dark"] .highlight-python.import {
+  box-shadow: 0px 0px 10px 0px #595959;
+}
+
+html[data-theme="dark"] .rst-content .highlighted {
+  background: #7e6500;
+  box-shadow: 0 0 0 2px #7e6500;
+}
+
+#native-gates-list > * {
+  position: relative;
+}
+
+#native-gates-list {
+  display: flex;
+  flex-wrap: wrap;
+  margin-block-end: 1em;
+  position: sticky;
+  top: 57px;
+  z-index: 10000;
+  background-color: #141414;
+}
+
+#native-gates-list > * {
+  padding: 0 1em 0 1em;
+  border: 0.5px solid;
+  border-block-start: 0;
+  border-block-end: 0;
+  border-color: black;
+  margin-block-end: 0.5em;
+}
+
+html[data-theme="dark"] #native-gates-list > * {
+  border-color: white;
+}
+
+section > * {
+  scroll-padding-block-start: 60px;
+}

docs/_static/custom.js

@@ -76,12 +76,41 @@ window.onload = () => {
       }
     }
   });
-};
 
-// const themeButton = document.querySelector('themeSwitcher')
-// themeButton.addEventListener('click', () => {
-//
-// });
+  // in the native gates section, add the list of native gates
+  ngListLocation = document.getElementById("native-gates-list");
+  if (ngListLocation) {
+    ngSection = ngListLocation.parentElement;
+    ngClasses = ngSection.querySelectorAll("dl.py.class");
+    ngLinks = "";
+
+    ngClasses.forEach(function (c) {
+      if (c.textContent.includes("ABC")) return;
+      ngLinks += `<a href="#${c.querySelector("dt.sig.sig-object.py").id}">
+        ${c.querySelector("span.descname").innerText}
+      </a>`;
+    });
+    ngListLocation.innerHTML = ngLinks;
+  }
+
+  // we add a note for abstract classes to remind that they cannot be
+  // implemented directly
+  document.querySelectorAll(".class").forEach((class_elt) => {
+    if (isABC(class_elt)) {
+      parents = class_elt.querySelector("dd > p:first-child");
+      template = document.createElement("template");
+      template.innerHTML = `
+      <div class="admonition note">
+        <p class="admonition-title"><span>Note</span></p>
+        <p>
+          Abstract classes (ABCs) are not meant to be instantiated as is. See 
+          classes that inherite from this one to check how to instantiate it.
+        </p>
+      </div>`;
+      parents.insertAdjacentElement("afterend", template.content.children[0]);
+    }
+  });
+};
 
 function getEndOfClassHeader(elt) {
   admonition = elt.querySelectorAll(".admonition");
@@ -93,6 +122,11 @@ function getEndOfClassHeader(elt) {
   return elt;
 }
 
+function isABC(elt) {
+  parents = elt.querySelector("dd > p:first-child");
+  return parents && parents.innerHTML.includes("ABC");
+}
+
 function isEnum(elt, explored = []) {
   id = elt.querySelector("dt").id;
   if (explored.includes(id)) return false;

docs/barrier.rst

@@ -2,6 +2,7 @@ Barriers
 ========
 
 .. code-block:: python
+    :class: import
 
     from mpqp import Barrier
 

docs/circuit.rst

@@ -2,6 +2,7 @@ The Quantum Circuit
 ===================
 
 .. code-block:: python
+    :class: import
 
     from mpqp import QCircuit 
 

docs/execution.rst

@@ -2,6 +2,7 @@ Execution
 =========
 
 .. code-block:: python
+    :class: import
 
     from mpqp.execution import *
 

docs/gates.rst

@@ -2,6 +2,7 @@ Gates
 =====
 
 .. code-block:: python
+    :class: import
 
     from mpqp.gates import *
 

docs/measures.rst

@@ -2,6 +2,7 @@ Measurements
 ============
 
 .. code-block:: python
+    :class: import
 
     from mpqp.measures import *
 

docs/noise.rst

@@ -14,6 +14,7 @@ details about the manipulation, usage, and simulation of noise models are
 presented.
 
 .. code-block:: python
+    :class: import
 
     from mpqp.noise import *
 

docs/qasm.rst

@@ -2,6 +2,7 @@ QASM converter
 ==================
 
 .. code-block:: python
+    :class: import
 
     from mpqp.qasm import *
 

docs/tools.rst

@@ -13,6 +13,7 @@ Useful Maths Operations
 -----------------------
 
 .. code-block:: python
+    :class: import
 
     from mpqp.tools.maths import *
 
@@ -22,6 +23,7 @@ Generics
 --------
 
 .. code-block:: python
+    :class: import
 
     from mpqp.tools.generics import *
 
@@ -31,6 +33,7 @@ Errors
 ------
 
 .. code-block:: python
+    :class: import
 
     from mpqp.tools.errors import *
 
@@ -40,6 +43,7 @@ Choice Tree
 -----------
 
 .. code-block:: python
+    :class: import
 
     from mpqp.tools.choice_tree import *
 

docs/vqa.rst

@@ -4,6 +4,7 @@ Variational Quantum Algorithms
 ==============================
 
 .. code-block:: python
+    :class: import
 
     from mpqp.execution.vqa import *
 
@@ -16,7 +17,7 @@ value attributed. It can be created as such:
 
 .. code-block:: python
 
-    from mpqp.execution.vqa import symbols
+    from sympy import symbols
 
     theta, k = symbols("Θ k")
 

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,