iqm-benchmarks 1.9__tar.gz → 1.11__tar.gz

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/.github/workflows/publish.yml

@@ -46,4 +46,36 @@ jobs:
       - name: Publish distribution packages to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-            attestations: false
+            attestations: false
+
+  publish_docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          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]"
+          sudo apt-get install graphviz
+      - name: Build docs
+        run: |
+          tox -e docs
+          touch build/sphinx/html/.nojekyll  # allow underscores in URL path
+          # remove unnecessary build files
+          sudo rm -rf build/sphinx/html/.doctrees
+      - name: Publish to gh-pages
+        uses: JamesIves/github-pages-deploy-action@4.1.4
+        with:
+          branch: gh-pages
+          folder: build/sphinx/html
+          force: false

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/.gitignore

@@ -20,6 +20,8 @@ __pycache__/
 # Build and docs folder/files
 /build/
 /dist/
+/sdist/
+/docs/api/
 version.txt
 
 # OS generated files

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/CHANGELOG.rst

@@ -2,6 +2,14 @@
 Changelog
 =========
 
+Version 1.11
+===========
+* Relaxes dependencies to allow for ranges.
+
+Version 1.10
+===========
+* Added API docs building and publishing.
+
 Version 1.9
 ===========
 * Fixed bug (overwriting observations) in Quantum Volume.

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-benchmarks
-Version: 1.9
+Version: 1.11
 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>
 Project-URL: Homepage, https://github.com/iqm-finland/iqm-benchmarks
@@ -13,17 +13,17 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lmfit>=1.2
 Requires-Dist: matplotlib<4,>=3.6.3
-Requires-Dist: more-itertools==10.1.0
+Requires-Dist: more-itertools<11.0.0,>=10.1.0
 Requires-Dist: mthree<2.7,>=2.6
-Requires-Dist: networkx==3.3
+Requires-Dist: networkx<4.0,>=3.3
 Requires-Dist: numpy<2.0,>=1.25.2
-Requires-Dist: qiskit>=1.0
-Requires-Dist: qiskit-iqm>=15.1
-Requires-Dist: scikit-optimize==0.10.2
-Requires-Dist: tabulate==0.9.0
-Requires-Dist: uncertainties==3.2.2
-Requires-Dist: pycurl==7.45.3
-Requires-Dist: xarray==2024.6.0
+Requires-Dist: qiskit<2.0,>=1.0
+Requires-Dist: qiskit-iqm<16.0,>=15.1
+Requires-Dist: scikit-optimize<0.11.0,>=0.10.2
+Requires-Dist: tabulate<1.0.0,>=0.9.0
+Requires-Dist: uncertainties<3.3.0,>=3.2.2
+Requires-Dist: pycurl<8.0,>=7.45.3
+Requires-Dist: xarray<2025.0.0,>=2024.6.0
 Requires-Dist: types-pycurl
 Provides-Extra: develop
 Requires-Dist: tox==4.16.0; extra == "develop"
@@ -45,6 +45,10 @@ Requires-Dist: pytest-cov==4.1.0; extra == "test"
 Requires-Dist: pytest-isort==3.1.0; extra == "test"
 Requires-Dist: pytest-mypy==0.10.3; extra == "test"
 Requires-Dist: pytest-pylint==0.21.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx==7.2.6; extra == "docs"
+Requires-Dist: sphinx-book-theme==1.1.2; extra == "docs"
+Requires-Dist: myst-parser<5,>=4.0.0; extra == "docs"
 
 # IQM Benchmarks
 
@@ -52,7 +56,7 @@ IQM Benchmarks is a suite of Quantum Characterization, Verification, and Validat
 
 
 Below is a list of the benchmarks currently available in the suite:
-* Gates / Layers: 
+* Gates / Layers:
   - Standard Clifford Randomized Benchmarking [[Phys. Rev. A 85, 042311](https://journals.aps.org/pra/abstract/10.1103/PhysRevA.85.042311) (2012)]
   - Interleaved Randomized Benchmarking [[Phys. Rev. Lett. 109, 080505](https://doi.org/10.1103/PhysRevLett.109.080505) (2012)]
   - Compressive Gate Set Tomography [[PRX Quantum 4, 010325](https://journals.aps.org/prxquantum/abstract/10.1103/PRXQuantum.4.010325) (2023)]
@@ -60,9 +64,9 @@ Below is a list of the benchmarks currently available in the suite:
 * Holistic:
   - Quantum Volume [[Phys. Rev. A 100, 032328](https://doi.org/10.1103/PhysRevA.100.032328) (2019)]
   - CLOPS [[arXiv:2110.14108 [quant-ph]](https://arxiv.org/abs/2110.14108) (2021)]
-* Entanglement: 
+* Entanglement:
   - GHZ State Fidelity [[arXiv:0712.0921 [quant-ph]](https://arxiv.org/abs/0712.0921) (2007)]
-* Optimization: 
+* Optimization:
   - Q-Score [[IEEE Trans. Quantum Eng., 2](https://doi.org/10.1109/TQE.2021.3090207) (2021)]
 
 The project is split into different benchmarks, all sharing the `Benchmark` class or the legacy `BenchmarkBase` class. Each individual benchmark takes as an argument their own `BenchmarkConfigurationBase` class. All the (legacy) benchmarks executed at once are wrapped by the `BenchmarkExperiment` class, which handles dependencies among the benchmarks, storing the results, producing the plots...
@@ -104,6 +108,12 @@ To run the tests, you can use the following command:
 tox -e test
 ```
 
+To build the API documentation as HTML:
+
+```bash
+tox -e docs
+```
+
 ## Characterize Physical Hardware
 
 The IQM Benchmarks suite is designed to be used with real quantum hardware. To use the suite, you will need to have access to a quantum computer. The suite is designed to work with both IQM Resonance (IQM's quantum cloud service) and on-prem devices, but can be easily adapted to work with other quantum computing platforms.

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/README.md

@@ -4,7 +4,7 @@ IQM Benchmarks is a suite of Quantum Characterization, Verification, and Validat
 
 
 Below is a list of the benchmarks currently available in the suite:
-* Gates / Layers: 
+* Gates / Layers:
   - Standard Clifford Randomized Benchmarking [[Phys. Rev. A 85, 042311](https://journals.aps.org/pra/abstract/10.1103/PhysRevA.85.042311) (2012)]
   - Interleaved Randomized Benchmarking [[Phys. Rev. Lett. 109, 080505](https://doi.org/10.1103/PhysRevLett.109.080505) (2012)]
   - Compressive Gate Set Tomography [[PRX Quantum 4, 010325](https://journals.aps.org/prxquantum/abstract/10.1103/PRXQuantum.4.010325) (2023)]
@@ -12,9 +12,9 @@ Below is a list of the benchmarks currently available in the suite:
 * Holistic:
   - Quantum Volume [[Phys. Rev. A 100, 032328](https://doi.org/10.1103/PhysRevA.100.032328) (2019)]
   - CLOPS [[arXiv:2110.14108 [quant-ph]](https://arxiv.org/abs/2110.14108) (2021)]
-* Entanglement: 
+* Entanglement:
   - GHZ State Fidelity [[arXiv:0712.0921 [quant-ph]](https://arxiv.org/abs/0712.0921) (2007)]
-* Optimization: 
+* Optimization:
   - Q-Score [[IEEE Trans. Quantum Eng., 2](https://doi.org/10.1109/TQE.2021.3090207) (2021)]
 
 The project is split into different benchmarks, all sharing the `Benchmark` class or the legacy `BenchmarkBase` class. Each individual benchmark takes as an argument their own `BenchmarkConfigurationBase` class. All the (legacy) benchmarks executed at once are wrapped by the `BenchmarkExperiment` class, which handles dependencies among the benchmarks, storing the results, producing the plots...
@@ -56,6 +56,12 @@ To run the tests, you can use the following command:
 tox -e test
 ```
 
+To build the API documentation as HTML:
+
+```bash
+tox -e docs
+```
+
 ## Characterize Physical Hardware
 
 The IQM Benchmarks suite is designed to be used with real quantum hardware. To use the suite, you will need to have access to a quantum computer. The suite is designed to work with both IQM Resonance (IQM's quantum cloud service) and on-prem devices, but can be easily adapted to work with other quantum computing platforms.

iqm_benchmarks-1.11/docs/API.rst

@@ -0,0 +1,9 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: api
+   :template: autosummary-module-template.rst
+   :recursive:
+
+   iqm.benchmarks

iqm_benchmarks-1.11/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = ../build/sphinx/
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

iqm_benchmarks-1.11/docs/_templates/autosummary-class-template.rst

@@ -0,0 +1,30 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes if item not in inherited_members %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+
+   {% block methods %}
+   {% if all_methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in all_methods if item not in inherited_members and item not in ['__init__'] %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

iqm_benchmarks-1.11/docs/_templates/autosummary-module-template.rst

@@ -0,0 +1,75 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: autosummary-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Subpackages and modules
+
+.. autosummary::
+   :toctree:
+   :template: autosummary-module-template.rst
+   :recursive:
+{% for item in modules %}
+   ~{{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
+
+{% block inheritance_diagram %}
+{% if classes %}
+.. rubric:: Inheritance
+
+.. inheritance-diagram:: {{ fullname }}
+   :parts: 1
+{% endif %}
+{% endblock %}

iqm_benchmarks-1.11/docs/changelog.rst

@@ -0,0 +1,2 @@
+.. _changes:
+.. include:: ../CHANGELOG.rst

iqm_benchmarks-1.11/docs/conf.py

@@ -0,0 +1,169 @@
+# Configuration file for the Sphinx documentation builder.
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+# Find the path to the source files we want to to document, relative to the location of this file,
+# convert it to an absolute path.
+py_path = os.path.join(os.getcwd(), os.path.dirname(__file__), '../src')
+sys.path.insert(0, os.path.abspath(py_path))
+
+# -- Project information -----------------------------------------------------
+
+project = 'IQM Benchmarks'
+copyright = '2024, IQM'
+author = 'IQM Benchmarks developers'
+
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+try:
+    from iqm.benchmarks import __version__ as version
+except ImportError:
+    pass
+else:
+    release = version
+
+# -- General configuration ---------------------------------------------------
+
+# require a recent version of Sphinx
+needs_sphinx = '7.2'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.todo',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.intersphinx',
+    'myst_parser'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# Include extra files in the HTML docs.
+html_extra_path = []
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.*']
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%Y-%m-%d'
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = True
+
+
+# -- Autodoc ------------------------------------------------------------
+
+# member ordering in autodoc output (default: 'alphabetical')
+autodoc_member_order = 'bysource'
+
+# where should signature annotations appear in the docs, function signature or parameter description?
+autodoc_typehints = 'both'
+# autodoc_typehints = 'description' puts the __init__ annotations into its docstring,
+# which we thus have to include in the class documentation.
+autoclass_content = 'class'
+
+# Sphinx 3.3+: manually clean up type alias rendering in the docs
+# autodoc_type_aliases = {'TypeAlias': 'exa.experiment.somemodule.TypeAlias'}
+
+
+# -- Autosummary ------------------------------------------------------------
+
+# use autosummary to generate stub pages for API docs
+autosummary_generate = True
+
+
+# -- Options for HTML output -------------------------------------------------
+
+import sphinx_book_theme
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_book_theme'
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [sphinx_book_theme.get_html_theme_path()]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {}
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = '_static/images/logo.png'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = '_static/images/favicon.ico'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'iqm_benchmarks-doc'
+
+
+# -- MathJax options ----------------------------------------------------------
+
+# Here we configure MathJax, mostly to define LaTeX macros.
+mathjax3_config = {
+    'tex': {
+        'macros': {
+            'vr': r'\vec{r}',  # no arguments
+            'ket': [r'\left| #1 \right\rangle', 1],  # one argument
+            'iprod': [r'\left\langle #1 | #2 \right\rangle', 2],  # two arguments
+        }
+    }
+}
+
+
+# -- External mapping ------------------------------------------------------------
+
+python_version = '.'.join(map(str, sys.version_info[0:2]))
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/' + python_version, None),
+}
+
+extlinks = {
+    'issue': ('https://github.com/iqm-finland/iqm-benchmarks/issues/%s', 'issue '),
+    'mr': ('https://github.com/iqm-finland/iqm-benchmarks/pull/%s', 'MR '),
+}
+
+
+# -- Options for sphinxcontrib.bibtex -------------------------------------------------
+
+# List of all bibliography files used.
+#bibtex_bibfiles = ['references.bib']

iqm_benchmarks-1.11/docs/index.rst

@@ -0,0 +1,32 @@
+IQM Benchmarks
+##########
+
+:Release: |release|
+:Date: |today|
+:Source Code: `<https://github.com/iqm-finland/iqm-benchmarks>`_
+
+Quantum Characterization, Verification, and Validation (QCVV) tools for quantum computing.
+Developed by `IQM <https://meetiqm.com/>`_.
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   API
+   license
+
+.. toctree::
+   :maxdepth: 1
+
+   changelog
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

iqm_benchmarks-1.11/docs/license.rst

@@ -0,0 +1,8 @@
+.. _license:
+
+=======
+License
+=======
+
+.. include:: ../LICENSE
+   :literal:

iqm_benchmarks-1.11/docs/readme.md

@@ -0,0 +1,2 @@
+```{include} ../README.md
+```

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/pyproject.toml

@@ -29,17 +29,17 @@ requires-python = ">=3.11"
 dependencies = [
     "lmfit >= 1.2",
     "matplotlib >= 3.6.3, < 4",
-    "more-itertools == 10.1.0",
+    "more-itertools >= 10.1.0, < 11.0.0",
     "mthree >= 2.6, < 2.7",
-    "networkx==3.3",
+    "networkx>=3.3, < 4.0",
     "numpy >= 1.25.2, < 2.0",
-    "qiskit >= 1.0",
-    "qiskit-iqm >= 15.1",
-    "scikit-optimize == 0.10.2",
-    "tabulate == 0.9.0",
-    "uncertainties == 3.2.2",
-    "pycurl == 7.45.3",
-    "xarray == 2024.6.0",
+    "qiskit >= 1.0, < 2.0",
+    "qiskit-iqm >= 15.1, < 16.0",
+    "scikit-optimize >= 0.10.2, < 0.11.0",
+    "tabulate >= 0.9.0, <1.0.0",
+    "uncertainties >= 3.2.2, < 3.3.0",
+    "pycurl >= 7.45.3, < 8.0",
+    "xarray >= 2024.6.0, < 2025.0.0",
     "types-pycurl",
 ]
 
@@ -75,6 +75,11 @@ test = [
     "pytest-pylint == 0.21.0",
 ]
 
+docs = [
+    "sphinx == 7.2.6",
+    "sphinx-book-theme == 1.1.2",
+    "myst-parser >= 4.0.0, < 5",
+]
 
 [tool.black]
 line-length = 120

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/src/iqm/benchmarks/benchmark_definition.py

@@ -135,6 +135,7 @@ def default_analysis_function(result: BenchmarkAnalysisResult) -> BenchmarkAnaly
 def merge_datasets_dac(datasets: List[xr.Dataset]) -> xr.Dataset:
     """
     Merges a list of datasets recursively to minimize dataset sizes during merge
+
     Args:
         datasets: List[xr.Dateset]
             A list of xarray datasets

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/src/iqm/benchmarks/compressive_gst/compressive_gst.py

@@ -369,6 +369,7 @@ def create_predefined_gate_set(gate_set, num_qubits) -> Tuple[List[QuantumCircui
 
     The circuits are assigned to the specified qubit_layouts on the backend only during transipilation, so the qubit labels
     at this stage may not represent the actual qubit labels on the backend.
+
     Args:
         gate_set: str
             The name of the gate set

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/src/iqm/benchmarks/entanglement/ghz.py

@@ -365,7 +365,8 @@ def generate_ghz_spanning_tree(
     n_state: int | None = None,
 ) -> Tuple[QuantumCircuit, List[int]]:
     """
-    Generates a GHZ state in log-depth by computing a minimal spanning tree for a given coupling map
+    Generates a GHZ state in log-depth by computing a minimal spanning tree for a given coupling map.
+
     Args:
         graph: networkx.Graph
             A graph of the backend coupling map
@@ -622,8 +623,9 @@ class GHZBenchmark(Benchmark):
 
     def generate_native_ghz(self, qubit_layout: List[int], qubit_count: int, routine: str) -> QuantumCircuit:
         """
-            Generate a circuit preparing a GHZ state,
-            according to a given routine and transpiled to the native gate set and topology
+        Generate a circuit preparing a GHZ state,
+        according to a given routine and transpiled to the native gate set and topology.
+
         Args:
             qubit_layout: List[int]
                 The subset of system-qubits used in the protocol, indexed from 0

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/src/iqm_benchmarks.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-benchmarks
-Version: 1.9
+Version: 1.11
 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>
 Project-URL: Homepage, https://github.com/iqm-finland/iqm-benchmarks
@@ -13,17 +13,17 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lmfit>=1.2
 Requires-Dist: matplotlib<4,>=3.6.3
-Requires-Dist: more-itertools==10.1.0
+Requires-Dist: more-itertools<11.0.0,>=10.1.0
 Requires-Dist: mthree<2.7,>=2.6
-Requires-Dist: networkx==3.3
+Requires-Dist: networkx<4.0,>=3.3
 Requires-Dist: numpy<2.0,>=1.25.2
-Requires-Dist: qiskit>=1.0
-Requires-Dist: qiskit-iqm>=15.1
-Requires-Dist: scikit-optimize==0.10.2
-Requires-Dist: tabulate==0.9.0
-Requires-Dist: uncertainties==3.2.2
-Requires-Dist: pycurl==7.45.3
-Requires-Dist: xarray==2024.6.0
+Requires-Dist: qiskit<2.0,>=1.0
+Requires-Dist: qiskit-iqm<16.0,>=15.1
+Requires-Dist: scikit-optimize<0.11.0,>=0.10.2
+Requires-Dist: tabulate<1.0.0,>=0.9.0
+Requires-Dist: uncertainties<3.3.0,>=3.2.2
+Requires-Dist: pycurl<8.0,>=7.45.3
+Requires-Dist: xarray<2025.0.0,>=2024.6.0
 Requires-Dist: types-pycurl
 Provides-Extra: develop
 Requires-Dist: tox==4.16.0; extra == "develop"
@@ -45,6 +45,10 @@ Requires-Dist: pytest-cov==4.1.0; extra == "test"
 Requires-Dist: pytest-isort==3.1.0; extra == "test"
 Requires-Dist: pytest-mypy==0.10.3; extra == "test"
 Requires-Dist: pytest-pylint==0.21.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx==7.2.6; extra == "docs"
+Requires-Dist: sphinx-book-theme==1.1.2; extra == "docs"
+Requires-Dist: myst-parser<5,>=4.0.0; extra == "docs"
 
 # IQM Benchmarks
 
@@ -52,7 +56,7 @@ IQM Benchmarks is a suite of Quantum Characterization, Verification, and Validat
 
 
 Below is a list of the benchmarks currently available in the suite:
-* Gates / Layers: 
+* Gates / Layers:
   - Standard Clifford Randomized Benchmarking [[Phys. Rev. A 85, 042311](https://journals.aps.org/pra/abstract/10.1103/PhysRevA.85.042311) (2012)]
   - Interleaved Randomized Benchmarking [[Phys. Rev. Lett. 109, 080505](https://doi.org/10.1103/PhysRevLett.109.080505) (2012)]
   - Compressive Gate Set Tomography [[PRX Quantum 4, 010325](https://journals.aps.org/prxquantum/abstract/10.1103/PRXQuantum.4.010325) (2023)]
@@ -60,9 +64,9 @@ Below is a list of the benchmarks currently available in the suite:
 * Holistic:
   - Quantum Volume [[Phys. Rev. A 100, 032328](https://doi.org/10.1103/PhysRevA.100.032328) (2019)]
   - CLOPS [[arXiv:2110.14108 [quant-ph]](https://arxiv.org/abs/2110.14108) (2021)]
-* Entanglement: 
+* Entanglement:
   - GHZ State Fidelity [[arXiv:0712.0921 [quant-ph]](https://arxiv.org/abs/0712.0921) (2007)]
-* Optimization: 
+* Optimization:
   - Q-Score [[IEEE Trans. Quantum Eng., 2](https://doi.org/10.1109/TQE.2021.3090207) (2021)]
 
 The project is split into different benchmarks, all sharing the `Benchmark` class or the legacy `BenchmarkBase` class. Each individual benchmark takes as an argument their own `BenchmarkConfigurationBase` class. All the (legacy) benchmarks executed at once are wrapped by the `BenchmarkExperiment` class, which handles dependencies among the benchmarks, storing the results, producing the plots...
@@ -104,6 +108,12 @@ To run the tests, you can use the following command:
 tox -e test
 ```
 
+To build the API documentation as HTML:
+
+```bash
+tox -e docs
+```
+
 ## Characterize Physical Hardware
 
 The IQM Benchmarks suite is designed to be used with real quantum hardware. To use the suite, you will need to have access to a quantum computer. The suite is designed to work with both IQM Resonance (IQM's quantum cloud service) and on-prem devices, but can be easily adapted to work with other quantum computing platforms.

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/src/iqm_benchmarks.egg-info/SOURCES.txt

@@ -9,6 +9,16 @@ tox.ini
 .github/workflows/main.yml
 .github/workflows/publish.yml
 .github/workflows/tag_and_release.yml
+docs/API.rst
+docs/Makefile
+docs/changelog.rst
+docs/conf.py
+docs/index.rst
+docs/license.rst
+docs/readme.md
+docs/_static/images/favicon.ico
+docs/_templates/autosummary-class-template.rst
+docs/_templates/autosummary-module-template.rst
 examples/example_clifford_rb.ipynb
 examples/example_clops.ipynb
 examples/example_experiment_all.ipynb

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/src/iqm_benchmarks.egg-info/requires.txt

@@ -1,21 +1,26 @@
 lmfit>=1.2
 matplotlib<4,>=3.6.3
-more-itertools==10.1.0
+more-itertools<11.0.0,>=10.1.0
 mthree<2.7,>=2.6
-networkx==3.3
+networkx<4.0,>=3.3
 numpy<2.0,>=1.25.2
-qiskit>=1.0
-qiskit-iqm>=15.1
-scikit-optimize==0.10.2
-tabulate==0.9.0
-uncertainties==3.2.2
-pycurl==7.45.3
-xarray==2024.6.0
+qiskit<2.0,>=1.0
+qiskit-iqm<16.0,>=15.1
+scikit-optimize<0.11.0,>=0.10.2
+tabulate<1.0.0,>=0.9.0
+uncertainties<3.3.0,>=3.2.2
+pycurl<8.0,>=7.45.3
+xarray<2025.0.0,>=2024.6.0
 types-pycurl
 
 [develop]
 tox==4.16.0
 
+[docs]
+sphinx==7.2.6
+sphinx-book-theme==1.1.2
+myst-parser<5,>=4.0.0
+
 [examples]
 notebook==7.2.1
 

{iqm_benchmarks-1.9 → iqm_benchmarks-1.11}/tox.ini

@@ -77,3 +77,16 @@ allowlist_externals = tox
 commands =
     tox -e clean
     python -m build
+
+
+[testenv:docs]
+description =
+    Invoke sphinx to build the docs.
+setenv =
+    DOCSDIR = {toxinidir}/docs
+    BUILDDIR = {toxinidir}/build/sphinx
+    BUILD = html
+extras =
+    docs
+commands =
+    sphinx-build -b {env:BUILD} "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}"