Update providers package versions

.github/workflows/tests.yml

@@ -16,6 +16,8 @@ on:
         options:
           - "3.10"
           - "3.11"
+          - "3.12"
+          - "3.13"
       commit_ref:
         description: Specific ref (branch, tag or SHA)
         default: ""
@@ -27,7 +29,7 @@ on:
         default: false
         type: boolean
       providers:
-        description: "Providers to enable (space-separated) e.g., 'qiskit cirq myqlm braket')"
+        description: "Providers to enable. Select 'all' or choose a specific provider."
         required: false
         default: "all"
         type: choice
@@ -42,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix: 
-        python-version: ${{ fromJSON(github.event_name == 'workflow_dispatch' && format('["{0}"]', github.event.inputs.python_v) || '["3.10", "3.11"]') }}
+        python-version: ${{ fromJSON(github.event_name == 'workflow_dispatch' && format('["{0}"]', github.event.inputs.python_v) || '["3.10", "3.11", "3.12", "3.13"]') }}
         provider: ${{ fromJSON(github.event_name == 'workflow_dispatch' && format('["{0}"]', github.event.inputs.providers) || (github.ref_name == 'main' && '["all", "qiskit", "cirq", "braket", "myqlm"]' || '["all"]')) }}
     steps:
       - name: Checkout repository
@@ -57,10 +59,8 @@ jobs:
       - name: Install python dependencies
         run: |
           pip install --upgrade pip
+         pip install ".[${{ matrix.provider }}]"
           pip install -r requirements-dev.txt
-          providers_comma=$(echo "${{ matrix.provider }}" | sed 's/ /,/g')
-          echo "$providers_comma"
-          pip install ".[$providers_comma]"
       - name: Install os specific dependencies
         if: ${{ github.event.inputs.long == 'true' || github.ref_name == 'main' }}
         run: |
@@ -78,7 +78,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ${{ fromJSON(github.event_name == 'workflow_dispatch' && format('["{0}"]', github.event.inputs.python_v) || '["3.10", "3.11"]') }}
+        python-version: ${{ fromJSON(github.event_name == 'workflow_dispatch' && format('["{0}"]', github.event.inputs.python_v) || '["3.10", "3.11", "3.12", "3.13"]') }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -92,7 +92,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install --upgrade pip
-          pip install -r requirements-dev.txt
           pip install -r requirements-all.txt
+          pip install -r requirements-dev.txt
       - name: Run type checker
         run: pyright

.gitignore

@@ -1,5 +1,7 @@
 # build artifacts
 build/
+docs/notebooks/
+docs/requirements_providers/
 docs/html/
 out/
 

CONTRIBUTING.md

@@ -94,13 +94,15 @@ 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                   |
-| `python -m pytest --long-local`       | Runs the local long tests                 |
-| `python -m pytest --seed=<your_seed>` | Runs the test suite with a specified seed |
+| 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                     |
+| `python -m pytest --seed=<your_seed>`    | Runs the test suite with a specified seed     |
+| `python -m pytest --provider <provider>` | Runs the test suite with a specified provider |
+
 
 When making commits, make sure to follow the
 [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)

Dockerfile

@@ -1,13 +1,13 @@
 # Stage 1: Build dependencies
-FROM python:3.9 AS builder
+FROM python:3.10 AS builder
 
 WORKDIR /usr/src/app
 
 COPY requirements.txt requirements-dev.txt ./
 RUN pip install --upgrade pip && \
     pip install --no-cache-dir -r requirements-dev.txt
 
-FROM python:3.9
+FROM python:3.10
 
 RUN apt update && \
     apt install -y \
@@ -27,7 +27,7 @@ RUN chmod +x linux_awscli_install.sh && ./linux_awscli_install.sh
 
 WORKDIR /usr/src/app/mpqp
 
-COPY --from=builder /usr/local/lib/python3.9/site-packages /usr/local/lib/python3.9/site-packages
+COPY --from=builder /usr/local/lib/python3.10/site-packages /usr/local/lib/python3.10/site-packages
 COPY .. /usr/src/app/mpqp/
 
 COPY requirements.txt requirements-dev.txt /usr/src/app/

README.md

@@ -25,7 +25,7 @@ On this page, you will find:
 
 ## Install
 
-For now, we support python versions 3.9 to 3.11, and every major OS (Windows,
+For now, we support python versions 3.10 to 3.13, and every major OS (Windows,
 Linux and MacOS). We are dependant on the SDKs we support to enable various
 python versions and OS support, for instance, MPQP was validated on Ubuntu LTS
 20.04, while Ubuntu 18.04 is not supported because myQLM does not support it.

docs/all-modules.rst

@@ -15,5 +15,4 @@ mpqp
     execution
     qasm
     tools
-    local_storage
-    environment
+    local_storage

docs/conf.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
+import shutil
 import sys
 from typing import Literal
 
@@ -40,7 +42,6 @@
     "sphinx_rtd_dark_mode",
     "sphinx_copybutton",
     "nbsphinx",  # requires pandoc ?
-    "nbsphinx_link",
 ]
 default_dark_mode = True
 autodoc_typehints = "description"
@@ -87,6 +88,68 @@
     \sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
 """
 
+
+def copy_notebooks(app: Sphinx):
+    app_dir = Path(app.srcdir).absolute()
+    src_dir = app_dir / "../examples/notebooks"
+    dest_dir = app_dir / "notebooks"
+
+    dest_dir.mkdir(exist_ok=True)
+
+    if not src_dir.exists():
+        raise FileNotFoundError(f"Source notebooks directory not found: {src_dir}")
+
+    for nb in src_dir.iterdir():
+        if nb.suffix == ".ipynb":
+            shutil.copy2(src_dir / nb, dest_dir)
+
+
+def copy_requirements_providers(app: Sphinx):
+    """
+    Copy requirements_providers/*.txt into docs/requirements_providers
+    so Sphinx can access them.
+    """
+    app_dir = Path(app.srcdir).absolute()
+    src_dir = app_dir / "../requirements_providers"
+    dest_dir = app_dir / "requirements_providers"
+
+    dest_dir.mkdir(exist_ok=True)
+
+    if not src_dir.exists():
+        raise FileNotFoundError(
+            f"Source requirements_providers directory not found: {src_dir}"
+        )
+
+    for src_file in src_dir.glob("*.txt"):
+        dest_file = dest_dir / src_file.name
+
+        if dest_file.exists():
+            dest_file.unlink()
+
+        shutil.copy2(src_file, dest_file)
+
+
+def generate_notebooks_toctree(app: Sphinx):
+    """
+    Automatically generate a toctree listing all notebooks
+    found in notebooks/.
+    """
+    notebooks_dir = Path(app.srcdir) / "notebooks"
+    notebooks_dir.mkdir(exist_ok=True)
+    output_file = notebooks_dir / "notebooks_toctree.rst"
+
+    notebooks = sorted(f for f in notebooks_dir.iterdir() if f.suffix == ".ipynb")
+    prefix = """.. toctree::
+   :maxdepth: 1
+   :caption: Notebooks:
+
+"""
+    with open(output_file, "w", encoding="utf-8") as f:
+        f.write(prefix)
+        for nb in notebooks:
+            f.write(f"   notebooks/{nb.stem}\n")
+
+
 # The suffix of source filenames.
 source_suffix = ".rst"
 
@@ -385,4 +448,7 @@ def maybe_skip_member(
 
 
 def setup(app: Sphinx):
+    app.connect("builder-inited", copy_notebooks)
+    app.connect("builder-inited", copy_requirements_providers)
     app.connect("autodoc-skip-member", maybe_skip_member)
+    app.connect("builder-inited", generate_notebooks_toctree)

docs/examples.rst

@@ -4,14 +4,4 @@ Examples
 On this page, you will find a few notebooks we provide as examples for various
 ``MPQP`` features.
 
-.. toctree::
-   :maxdepth: 1
-   :caption: Notebooks:
-
-   notebooks/1_Basics_of_circuit
-   notebooks/2_Execution_Bell_circuit
-   notebooks/3_Expectation_value_of_observables
-   notebooks/4_Quantum_Fourier_Transform
-   notebooks/5_Variational_Quantum_Algorithms
-   notebooks/6_Noise_Simulation
-   notebooks/8_TSP_QAOA
+.. include:: notebooks/notebooks_toctree.rst

docs/gates.rst

@@ -58,4 +58,4 @@ Custom Gates
 Controlled Custom Gates
 -----------------------
 
-.. automodule:: mpqp.core.instruction.gates.controlled_custom_gate
+.. automodule:: mpqp.core.instruction.gates.custom_controlled_gate

docs/getting-started.rst

@@ -7,23 +7,95 @@ Installation
 .. TODO: grab the compatibility matrix from MyQLM and relax our requirements 
 .. when possible, test on many different configurations (tox or other ?)
 
-For now, we support Python versions 3.9 to 3.11, and all of Windows, Linux and 
+For now, we support Python versions 3.10 to 3.13, 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
+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
+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::
+    To keep the installation lightweight and avoid installing unnecessary
+    dependencies, each provider is distributed as a **separate pip extra**.
+    By default, only the core functionalities of ``mpqp`` and qiskit local
+    simulation are installed, which means that you can create and manipulate circuits, 
+    but you won't be able to run them on any backend.
+
+Add more providers
+--------------------------
+
+``mpqp`` provides integrations with several quantum SDKs and execution backends.
+
+- **Installing all providers**:
+
+    .. code-block:: console
+
+        $ pip install mpqp["all"]
+
+
+- **Qiskit**:
+
+    .. code-block:: console
+
+        $ pip install mpqp["qiskit"]
+
+.. literalinclude:: requirements_providers/qiskit.txt
+   :language: text
+
+- **Azure Quantum**:
+
+    .. code-block:: console
+
+        $ pip install mpqp["azure"]
+
+.. literalinclude:: requirements_providers/azure.txt
+   :language: text
+
+- **Amazon Braket**:
+
+    .. code-block:: console
+
+        $ pip install mpqp["braket"]
+
+.. literalinclude:: requirements_providers/braket.txt
+   :language: text
+
+- **myQLM**:
+
+    .. code-block:: console
+
+        $ pip install mpqp["myqlm"]
+
+.. literalinclude:: requirements_providers/myqlm.txt
+   :language: text
+
+
+- **Cirq**:
+
+    .. code-block:: console
+
+        $ pip install mpqp["cirq"]
+
+.. literalinclude:: requirements_providers/cirq.txt
+   :language: text
+
+
+You can also combine extras, for example, to install both Qiskit and Braket support:
+
+    .. code-block:: console
+
+        $ pip install mpqp["qiskit", "braket"]
+
 .. note::
     For Mac users, additional steps are required before installation, 
     specifically because of the ``myqlm`` library. To run these steps, you can 
@@ -36,7 +108,7 @@ version, run instead
         $ 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``.
+    be ``python``, ``python3``, or ``python3.10``.
 
 .. warning::
     The migration from ``qiskit`` version ``0.x`` to ``1.x`` caused a few issues. 

docs/index.rst

@@ -41,7 +41,6 @@ on the current available SDKs:
    vqa
    qasm
    tools
-   environment
    local_storage
    changelog
    examples