iqm-benchmarks 2.8__tar.gz → 2.9__tar.gz

iqm_benchmarks-2.9/.github/workflows/main.yml

@@ -0,0 +1,75 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: uv pip install --constraint requirements.txt --editable .[test,mgst]
+      - name: Run tests
+        run: ./test
+  
+  test_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          uv pip install --constraint requirements.txt --editable .[docs,mgst]
+          sudo apt-get install graphviz
+      - name: Test if docs can be built
+        run: ./docbuild
+  
+  test_requirements_lock:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: uv pip install --constraint requirements.txt --editable .[cicd]
+      - name: Regenerate requirements.txt
+        run: python update-requirements.py
+      - name: Check lockfile is up-to-date
+        run: git diff --exit-code HEAD requirements.txt
+
+  run_benchmark:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || github.event_name == 'schedule'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: uv pip install --constraint requirements.txt --editable .
+      - name: Run benchmark
+        run: python benchmark_runner.py --backend=${BACKEND}
+        env:
+          BACKEND: ${{ github.event.inputs.backend || 'iqmfakeadonis' }}
+      - name: Upload benchmark results
+        uses: actions/upload-artifact@v2
+        with:
+          name: benchmark-results
+          path: Outputs
+

{iqm_benchmarks-2.8 → iqm_benchmarks-2.9}/.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Upload package to PyPI
+name: Upload package to PyPI and publish documentation
 
 on:
   release:
@@ -9,21 +9,18 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
       - name: Fetch all history for all tags and branches
         run: git fetch --prune --unshallow
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11'
+          python-version: 3.11
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install build==1.0.3
+        run: uv pip install --constraint requirements.txt --editable .[cicd]
       - name: Build distribution
-        run: python -m build
+        run: uv build
       - name: Store distribution packages
         uses: actions/upload-artifact@v4
         with:
@@ -39,7 +36,6 @@ jobs:
       url: https://pypi.org/p/iqm-benchmarks
     permissions:
       id-token: write
-
     steps:
       - name: Download distribution packages
         uses: actions/download-artifact@v4
@@ -50,26 +46,24 @@ jobs:
 
   publish_docs:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11'
+          python-version: 3.11
       - name: Checkout latest tagged commit
         run: |
           git checkout $(git describe --tags --abbrev=0)
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -e ".[develop]"
+          uv pip install --constraint requirements.txt --editable .[cicd,docs]
           sudo apt-get install graphviz
       - name: Build docs
         run: |
-          tox -e docs
+          ./docbuild
           touch build/sphinx/html/.nojekyll  # allow underscores in URL path
           # remove unnecessary build files
           sudo rm -rf build/sphinx/html/.doctrees
@@ -78,4 +72,26 @@ jobs:
         with:
           branch: gh-pages
           folder: build/sphinx/html
-          force: false
+          force: false
+
+  gen_licenses_info:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: uv pip install --constraint requirements.txt --editable . --requirement pyproject.toml --all-extras
+      - name: Generate license information for dependencies
+        run: |
+          pip-licenses --format=confluence --with-urls > licenses.txt
+          cat -n licenses.txt | sort -uk2 | sort -n | cut -f2- > tmp && mv tmp licenses.txt  # remove duplicate lines
+      - name: Upload license information artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dependencies-licenses
+          path: licenses.txt

{iqm_benchmarks-2.8 → iqm_benchmarks-2.9}/CHANGELOG.rst

@@ -2,6 +2,9 @@
 Changelog
 =========
 
+Version 2.9
+===========
+* Add optional security-scanned lockfile.
 
 Version 2.8
 ===========
@@ -45,15 +48,15 @@ Version 2.0
 * Updates the usage of `qiskit.QuantumCircuit` to `iqm.qiskit_iqm.IQMCircuit` in many places.
 
 Version 1.12
-===========
+============
 * Miscellaneous small bugs fixed.
 
 Version 1.11
-===========
+============
 * Relaxes dependencies to allow for ranges.
 
 Version 1.10
-===========
+============
 * Added API docs building and publishing.
 
 Version 1.9

iqm_benchmarks-2.9/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

{iqm_benchmarks-2.8/src/iqm_benchmarks.egg-info → iqm_benchmarks-2.9}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.2
 Name: iqm-benchmarks
-Version: 2.8
+Version: 2.9
 Summary: A package for implementation of Quantum Characterization, Verification and Validation (QCVV) techniques on IQM's hardware at gate level abstraction
-Author-email: IQM Finland Oy <developers@meetiqm.com>, Aniket Rath <aniket.rath@meetiqm.com>, Jami Rönkkö <jami@meetiqm.com>, Pedro Figueroa Romero <pedro.romero@meetiqm.com>, Vicente Pina Canelles <vicente.pina@meetiqm.com>, Raphael Brieger <raphael.brieger@meetiqm.com>, Stefan Seegerer <stefan.seegerer@meetiqm.com>
+Author-email: IQM Finland Oy <developers@meetiqm.com>, Aniket Rath <aniket.rath@meetiqm.com>, Jami Rönkkö <jami@meetiqm.com>, Pedro Figueroa Romero <pedro.romero@meetiqm.com>, Vicente Pina Canelles <vicente.pina@meetiqm.com>, Raphael Brieger <raphael.brieger@meetiqm.com>, Stefan Seegerer <stefan.seegerer@meetiqm.com>, Miikka Koistinen <miikka@meetiqm.com>
 Project-URL: Homepage, https://github.com/iqm-finland/iqm-benchmarks
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -26,8 +26,9 @@ Requires-Dist: pycurl<8.0,>=7.45.3
 Requires-Dist: xarray<2025.0.0,>=2024.6.0
 Requires-Dist: types-pycurl
 Requires-Dist: myst-nb==1.1.0
-Provides-Extra: develop
-Requires-Dist: tox==4.16.0; extra == "develop"
+Provides-Extra: cicd
+Requires-Dist: build==1.0.3; extra == "cicd"
+Requires-Dist: pip-licenses==5.0.0; extra == "cicd"
 Provides-Extra: examples
 Requires-Dist: notebook==7.2.1; extra == "examples"
 Provides-Extra: mgst
@@ -73,57 +74,71 @@ The project is split into different benchmarks, all sharing the `Benchmark` clas
 
 ## Installation _(latest release)_
 
-Usually it makes sense to use a new Conda environment (e.g. ``iqm-benchmarks``) to isolate your setup from the global Python installation. That way, you can play around without messing the rest of your system.
+[uv](https://docs.astral.sh/uv/) is highly recommended for practical Python environment and package management.
+With uv installed in your system, start a terminal in your machine and create a new Python environment
 
-Start a terminal in your machine, and type
-
-```
-conda create -n iqm-benchmarks python=3.11.2
-conda activate iqm-benchmarks
+```sh
+uv venv --python=3.11
 ```
 
+> Note: refer to uv's documentation if there are problems setting up a Python environment.
+
+After the command has run, read the output and make sure to use the prompt to activate the environment.
 Then, you can install the latest release of the IQM Benchmarks by running:
-```bash
-$ pip install iqm-benchmarks
+
+```sh
+uv pip install iqm-benchmarks
 ```
 
-If you have already installed `iqm-benchmarks` and want to get the latest release you can add the --upgrade flag:
+Supplied within the Python package there is an additional `requirements.txt` file containing locked, security scanned
+dependencies. The file can be used to constrain installed dependencies either directly from the repo or by
+extracting it from the PyPI package.
 
-```bash
-pip install iqm-benchmarks --upgrade
+```sh
+uv pip install --constraint requirements.txt iqm-benchmarks
 ```
 
 ## Optional dependencies
 
 Optional dependencies like compressive gate set tomography and jupyter notebooks can be installed as follows:
-```bash
-pip install "iqm-benchmarks[mgst, examples]"
+```sh
+uv pip install "iqm-benchmarks[mgst,examples]"
 ```
 Current optional dependencies are:
 * `examples`: Jupyter notebooks
 * `mgst`: Compressive gate set tomography
-* `develop`: Development tools
 * `test`: Code testing and Linting
-* `docs`: Documentation building 
+* `docs`: Documentation building
+* `cicd`: CICD tools
 
-## Development mode _(latest changes: recommended)_
+## Development installation _(latest changes)_
 
-To install in development mode with all required dependencies, you can instead clone the [repository](https://www.github.com/iqm-finland/iqm-benchmarks) and from the project directory run
+To install in development mode with all required dependencies, you can instead clone the
+[repository](https://www.github.com/iqm-finland/iqm-benchmarks) and from the project directory run
 
-```bash
-python -m pip install -e ".[develop,test]" --upgrade --upgrade-strategy=eager
+```sh
+uv pip install --constraint requirements.txt iqm-benchmarks
 ```
 
 To run the tests, you can use the following command:
 
-```bash
-tox -e test
+```sh
+./test
 ```
 
 To build the API documentation as HTML:
 
-```bash
-tox -e docs
+```sh
+./docbuild
+```
+
+Update the requirements. This is necessary when you add a new dependency or update an existing one in `pyproject.toml`.
+After this, any changes in the lockfile `requirements.txt` have to be committed.
+The script upgrades locked dependencies defined in `pyproject.toml` within the given version ranges. However, transitive
+dependencies are deliberately not upgraded automatically.
+
+```sh
+python update-requirements.py
 ```
 
 ## Characterize Physical Hardware

{iqm_benchmarks-2.8 → iqm_benchmarks-2.9}/README.md

@@ -22,57 +22,71 @@ The project is split into different benchmarks, all sharing the `Benchmark` clas
 
 ## Installation _(latest release)_
 
-Usually it makes sense to use a new Conda environment (e.g. ``iqm-benchmarks``) to isolate your setup from the global Python installation. That way, you can play around without messing the rest of your system.
+[uv](https://docs.astral.sh/uv/) is highly recommended for practical Python environment and package management.
+With uv installed in your system, start a terminal in your machine and create a new Python environment
 
-Start a terminal in your machine, and type
-
-```
-conda create -n iqm-benchmarks python=3.11.2
-conda activate iqm-benchmarks
+```sh
+uv venv --python=3.11
 ```
 
+> Note: refer to uv's documentation if there are problems setting up a Python environment.
+
+After the command has run, read the output and make sure to use the prompt to activate the environment.
 Then, you can install the latest release of the IQM Benchmarks by running:
-```bash
-$ pip install iqm-benchmarks
+
+```sh
+uv pip install iqm-benchmarks
 ```
 
-If you have already installed `iqm-benchmarks` and want to get the latest release you can add the --upgrade flag:
+Supplied within the Python package there is an additional `requirements.txt` file containing locked, security scanned
+dependencies. The file can be used to constrain installed dependencies either directly from the repo or by
+extracting it from the PyPI package.
 
-```bash
-pip install iqm-benchmarks --upgrade
+```sh
+uv pip install --constraint requirements.txt iqm-benchmarks
 ```
 
 ## Optional dependencies
 
 Optional dependencies like compressive gate set tomography and jupyter notebooks can be installed as follows:
-```bash
-pip install "iqm-benchmarks[mgst, examples]"
+```sh
+uv pip install "iqm-benchmarks[mgst,examples]"
 ```
 Current optional dependencies are:
 * `examples`: Jupyter notebooks
 * `mgst`: Compressive gate set tomography
-* `develop`: Development tools
 * `test`: Code testing and Linting
-* `docs`: Documentation building 
+* `docs`: Documentation building
+* `cicd`: CICD tools
 
-## Development mode _(latest changes: recommended)_
+## Development installation _(latest changes)_
 
-To install in development mode with all required dependencies, you can instead clone the [repository](https://www.github.com/iqm-finland/iqm-benchmarks) and from the project directory run
+To install in development mode with all required dependencies, you can instead clone the
+[repository](https://www.github.com/iqm-finland/iqm-benchmarks) and from the project directory run
 
-```bash
-python -m pip install -e ".[develop,test]" --upgrade --upgrade-strategy=eager
+```sh
+uv pip install --constraint requirements.txt iqm-benchmarks
 ```
 
 To run the tests, you can use the following command:
 
-```bash
-tox -e test
+```sh
+./test
 ```
 
 To build the API documentation as HTML:
 
-```bash
-tox -e docs
+```sh
+./docbuild
+```
+
+Update the requirements. This is necessary when you add a new dependency or update an existing one in `pyproject.toml`.
+After this, any changes in the lockfile `requirements.txt` have to be committed.
+The script upgrades locked dependencies defined in `pyproject.toml` within the given version ranges. However, transitive
+dependencies are deliberately not upgraded automatically.
+
+```sh
+python update-requirements.py
 ```
 
 ## Characterize Physical Hardware

iqm_benchmarks-2.9/docbuild

@@ -0,0 +1 @@
+sphinx-build -b html docs/ build/sphinx/html -W

{iqm_benchmarks-2.8 → iqm_benchmarks-2.9}/docs/index.rst

@@ -1,5 +1,5 @@
 IQM Benchmarks
-##########
+##############
 
 :Release: |release|
 :Date: |today|

iqm_benchmarks-2.9/format

@@ -0,0 +1,2 @@
+python -m isort src tests
+python -m black src tests

{iqm_benchmarks-2.8 → iqm_benchmarks-2.9}/pyproject.toml

@@ -1,5 +1,9 @@
 [build-system]
 requires = [
+    # NOTE: including build deps in the lockfile not yet directly by uv. Working around this by duplicating build deps
+    #       in project dependencies doesn't work either since using them via the lockfile requires
+    #       `--no-build-isolation` while installing, which itself requires setuptools.
+    #       See https://github.com/astral-sh/uv/issues/5190.
     "setuptools>=70.0.0",
     "setuptools_scm[toml]>=8.1.0",
 ]
@@ -16,7 +20,8 @@ authors = [
     {name="Pedro Figueroa Romero", email="pedro.romero@meetiqm.com"},
     {name="Vicente Pina Canelles", email="vicente.pina@meetiqm.com"},
     {name="Raphael Brieger", email="raphael.brieger@meetiqm.com"},
-    {name="Stefan Seegerer", email="stefan.seegerer@meetiqm.com"}
+    {name="Stefan Seegerer", email="stefan.seegerer@meetiqm.com"},
+    {name="Miikka Koistinen", email="miikka@meetiqm.com"},
 ]
 readme = "README.md"
 classifiers = [
@@ -48,8 +53,9 @@ dependencies = [
 "Homepage" = "https://github.com/iqm-finland/iqm-benchmarks"
 
 [project.optional-dependencies]
-develop = [
-    "tox == 4.16.0",
+cicd = [
+    "build == 1.0.3",
+    "pip-licenses == 5.0.0",
 ]
 
 examples = [