Draft: Qiskit Primitives V2 Migration

.github/workflows/tests.yaml

@@ -5,24 +5,120 @@ on:
     - cron: '23 1 * * *'
 
 jobs:
-  pytest:
+  pytest_minimal_requirements:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          python -m venv venv_minimal
+          source venv_minimal/bin/activate
+          pip install toml
+          python3 install_lowest_dependencies.py
+      - name: Test with pytest
+        run: |
+          source venv_minimal/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: Test examples
+        run: |
+          source venv_minimal/bin/activate
+          pip install nbmake
+          pytest --nbmake --nbmake-timeout 600 examples/
+      - name: clean
+        run: |
+          rm -rf venv_minimal
+
+  pytest_qiskit_0_46:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv venv_qiskit_0_46
+          source venv_qiskit_0_46/bin/activate
+          pip install .[examples] qiskit==0.46.3 qiskit-ibm-runtime==0.20.0
+      - name: Test with pytest
+        run: |
+          source venv_qiskit_0_46/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: Test examples
+        run: |
+          source venv_qiskit_0_46/bin/activate
+          pip install nbmake
+          pytest --nbmake --nbmake-timeout 600 examples/
+      - name: clean
+        run: |
+          rm -rf venv_qiskit_0_46
+
+  pytest_qiskit_1:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv venv_qiskit_1
+          source venv_qiskit_1/bin/activate
+          pip install .[examples] qiskit==1.1.2 qiskit-ibm-runtime==0.27.1
+      - name: Test with pytest
+        run: |
+          source venv_qiskit_1/bin/activate
+          pip install pytest
+          pytest tests/
+      - name: Test examples
+        run: |
+          source venv_qiskit_1/bin/activate
+          pip install nbmake
+          pytest --nbmake --nbmake-timeout 600 examples/
+      - name: clean
+        run: |
+          rm -rf venv_qiskit_1
+
+  pytest_latest: 
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: |
+            3.12
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv venv_latest
+          source venv_latest/bin/activate
           pip install .[examples]
       - name: Test with pytest
         run: |
+          source venv_latest/bin/activate
           pip install pytest
           pytest tests/
       - name: Test examples
         run: |
+          source venv_latest/bin/activate
           pip install nbmake
-          pytest --nbmake --nbmake-timeout 600 examples/ 
+          pytest --nbmake --nbmake-timeout 600 examples/
+      - name: clean
+        run: |
+          rm -rf venv_latest

docs/install/install.rst

@@ -9,14 +9,20 @@ Prerequisites
 sQUlearn requires a recent python3 (>=3.9) installation.
 Additionally the following python packages are necessary: ::
 
-    numpy>=1.17
-    scipy>=1.5
-    scikit-learn>=1.0
-    qiskit>=0.42.1
+    bayesian-optimization>=1.4.3,<2
+    dill>=0.3.4
+    mapomatic>=0.10.0
+    networkx>=3.0
+    numpy>=1.20
+    pennylane>=0.34.0
+    qiskit>=0.45.0
     qiskit-aer>=0.12.0
-    qiskit-machine-learning>=0.6.0
-    qiskit-ibm-runtime>=0.9
-    dill>=0.3
+    qiskit-algorithms>=0.3.0
+    qiskit-ibm-runtime>=0.18.0
+    qiskit-machine-learning>=0.7.0
+    scipy>=1.8.0
+    scikit-learn>=1.2.0,<1.4.2
+    tqdm>=4.1.0
 
 The packages are automatically installed when installing sQUlearn with pip.
 
@@ -48,3 +54,28 @@ To install the latest development version:
 .. code-block:: bash
 
     pip install git+https://github.com/sQUlearn/squlearn.git@develop
+
+
+
+Installation with optional dependencies:
+----------------------------------------
+
+There are several optional dependencies that can be installed with sQUlearn.
+To install sQUlearn with the dependencies usefull for development, run the following command:
+
+.. code-block:: bash
+
+    pip install squlearn[dev]
+
+To install sQUlearn with the dependencies necessary to run all examples, run the following command:
+
+.. code-block:: bash
+
+    pip install squlearn[examples]
+
+And to install sQUlearn with the dependencies necessary to build the documentation,
+run the following command:
+
+.. code-block:: bash
+
+    pip install squlearn[docs]

docs/user_guide/encoding_circuits.rst

@@ -152,7 +152,7 @@ sQUlearn features a fully automated pruning algorithm which can be used by calli
    from squlearn.encoding_circuit import LayeredEncodingCircuit, automated_pruning
    from squlearn.util import Executor
    encoding_circuit = LayeredEncodingCircuit.from_string("Rz(p)-Ry(p)-Z-Ry(p)-Rz(p)", num_qubits=2, num_features=0)
-   pruned_encoding_circuit = automated_pruning(encoding_circuit, Executor("statevector_simulator"))
+   pruned_encoding_circuit = automated_pruning(encoding_circuit, Executor())
    pruned_encoding_circuit.draw(output="mpl")