iqm-benchmarks 2.7__py3-none-any.whl → 2.9__py3-none-any.whl

iqm/benchmarks/__init__.py

@@ -26,7 +26,6 @@ from .benchmark_definition import (
     BenchmarkRunResult,
 )
 from .circuit_containers import BenchmarkCircuit, CircuitGroup, Circuits
-from .compressive_gst.compressive_gst import CompressiveGST, GSTConfiguration
 from .entanglement.ghz import GHZBenchmark, GHZConfiguration
 from .quantum_volume.clops import CLOPSBenchmark, CLOPSConfiguration
 from .quantum_volume.quantum_volume import QuantumVolumeBenchmark, QuantumVolumeConfiguration
@@ -47,6 +46,15 @@ AVAILABLE_BENCHMARKS = {
     MirrorRandomizedBenchmarking.name: MirrorRandomizedBenchmarking,
 }
 
+try:
+    # Requires dependencies from "project.optional-dependencies.mgst" section to be installed. See "pyproject.toml"
+    # file
+    from .compressive_gst.compressive_gst import CompressiveGST, GSTConfiguration
+
+    AVAILABLE_BENCHMARKS.update({CompressiveGST.name: CompressiveGST})
+except ModuleNotFoundError:
+    pass
+
 try:
     # Change here if project is renamed and does not equal the package name
     dist_name = "iqm-benchmarks"

iqm/benchmarks/compressive_gst/compressive_gst.py

@@ -58,6 +58,8 @@ class CompressiveGST(Benchmark):
 
     analysis_function = staticmethod(mgst_analysis)
 
+    name: str = "compressive_gst"
+
     def __init__(self, backend: IQMBackendBase, configuration: "GSTConfiguration"):
         """Construct the compressive_gst class.
 
@@ -102,10 +104,6 @@ class CompressiveGST(Benchmark):
         self.J = np.empty((self.configuration.num_circuits, self.num_povm))
         self.bootstrap_results = List[Tuple[np.ndarray]]  # List of GST outcomes from bootstrapping
 
-    @staticmethod
-    def name() -> str:
-        return "compressive_GST"
-
     @timeit
     def generate_meas_circuits(self) -> None:
         """Generate random circuits from the gate set
@@ -172,7 +170,7 @@ class CompressiveGST(Benchmark):
         # Adding configuration entries and class variables, prioritizing the latter in case of conflicts
         for key, value in (self.configuration.__dict__ | self.__dict__).items():
             if key == "benchmark":  # Avoid saving the class objects
-                dataset.attrs[key] = value.name()
+                dataset.attrs[key] = value.name
             elif key == "backend":
                 dataset.attrs[key] = value.name
             else:

iqm/benchmarks/compressive_gst/gst_analysis.py

@@ -557,20 +557,20 @@ def pandas_results_to_observations(
     """Converts high level GST results from a pandas Dataframe to a simple observation dictionary
 
     Args:
-    dataset: xarray.Dataset
-        A dataset containing counts from the experiment and configurations
-    qubit_layout: List[int]
-        The list of qubits for the current GST experiment
-    df_g: Pandas DataFrame
-        The dataframe with properly formated gate results
-    df_o: Pandas DataFrame
-        The dataframe with properly formated non-gate results like SPAM error measures or fit quality.
-    identifier: BenchmarkObservationIdentifier
-        An identifier object for the current GST run
+        dataset: xarray.Dataset
+            A dataset containing counts from the experiment and configurations
+        qubit_layout: List[int]
+            The list of qubits for the current GST experiment
+        df_g: Pandas DataFrame
+            The dataframe with properly formated gate results
+        df_o: Pandas DataFrame
+            The dataframe with properly formated non-gate results like SPAM error measures or fit quality.
+        identifier: BenchmarkObservationIdentifier
+            An identifier object for the current GST run
 
     Returns:
-    observation_list: List[BenchmarkObservation]
-        List of observations converted from the pandas dataframes
+        observation_list: List[BenchmarkObservation]
+            List of observations converted from the pandas dataframes
     """
     observation_list: list[BenchmarkObservation] = []
     err = dataset.attrs["bootstrap_samples"] > 0

iqm/benchmarks/quantum_volume/quantum_volume.py

@@ -677,7 +677,8 @@ class QuantumVolumeBenchmark(Benchmark):
         sorted_transpiled_qc_list: Dict[Tuple[int, ...], List[QuantumCircuit]],
     ) -> Dict[str, Any]:
         """
-            Submit jobs for execution in the specified IQMBackend.
+        Submit jobs for execution in the specified IQMBackend.
+
         Args:
             backend (IQMBackendBase): the IQM backend to submit the job.
             qubits (List[int]): the qubits to identify the submitted job.
@@ -862,8 +863,7 @@ class QuantumVolumeConfiguration(BenchmarkConfigurationBase):
                             - "fixed": Restricts the coupling map to only the specified qubits.
                             - "batching": Considers the full coupling map of the backend and circuit execution is batched per final layout.
                             * Default is "fixed"
-        rem (bool): Whether Readout Error Mitigation is applied in post-processing.
-                    When set to True, both results (readout-unmitigated and -mitigated) are produced.
+        rem (bool): Whether Readout Error Mitigation is applied in post-processing. When set to True, both results (readout-unmitigated and -mitigated) are produced.
                             - Default is True.
         mit_shots (int): The measurement shots to use for readout calibration.
                             * Default is 1_000.

iqm/benchmarks/randomized_benchmarking/mirror_rb/mirror_rb.py

@@ -620,7 +620,8 @@ class MirrorRandomizedBenchmarking(Benchmark):
         sorted_transpiled_circuit_dicts: Dict[Tuple[int, ...], List[QuantumCircuit]],
     ) -> Dict[str, Any]:
         """
-            Submit fixed-depth MRB jobs for execution in the specified IQMBackend
+        Submit fixed-depth MRB jobs for execution in the specified IQMBackend
+
         Args:
             backend_arg (IQMBackendBase): the IQM backend to submit the job
             qubits (Sequence[int]): the qubits to identify the submitted job

{iqm_benchmarks-2.7.dist-info → iqm_benchmarks-2.9.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.2
 Name: iqm-benchmarks
-Version: 2.7
+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,16 +26,15 @@ 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
-Requires-Dist: numpy<2.0; extra == "mgst"
-Requires-Dist: cvxpy==1.5.3; extra == "mgst"
-Requires-Dist: pygsti==0.9.12.3; extra == "mgst"
-Requires-Dist: tqdm==4.66.5; extra == "mgst"
 Requires-Dist: numba==0.60.0; extra == "mgst"
+Requires-Dist: pygsti[diamond_norm]==0.9.12.3; extra == "mgst"
+Requires-Dist: tqdm==4.66.5; extra == "mgst"
 Provides-Extra: test
 Requires-Dist: black==24.4.2; extra == "test"
 Requires-Dist: isort==5.13.2; extra == "test"
@@ -75,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.
-
-Start a terminal in your machine, and type
+[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
 
+```sh
+uv venv --python=3.11
 ```
-conda create -n iqm-benchmarks python=3.11.2
-conda activate iqm-benchmarks
-```
 
+> 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.7.dist-info → iqm_benchmarks-2.9.dist-info}/RECORD

@@ -1,4 +1,4 @@
-iqm/benchmarks/__init__.py,sha256=sFDsukGeEKJfTO3kaBli0bz8gSewemon35yHAx7bOQY,2279
+iqm/benchmarks/__init__.py,sha256=Hc0oxTTjCA2QlLJeD7lBBt84l1tFbAF5WkAhP92JmgA,2525
 iqm/benchmarks/benchmark.py,sha256=SGhBcSxLPUu-cVXAjG4Db2TRobFCRBYoE1NtTDK1lJg,4432
 iqm/benchmarks/benchmark_definition.py,sha256=AZkvANrf0_0glbq_P_uo_YqbBU9IZa2gJlMVz6qT6VU,10500
 iqm/benchmarks/circuit_containers.py,sha256=anEtZEsodYqOX-34oZRmuKGeEpp_VfgG5045Mz4-4hI,7562
@@ -6,15 +6,15 @@ iqm/benchmarks/logging_config.py,sha256=U7olP5Kr75AcLJqNODf9VBhJLVqIvA4AYR6J39D5
 iqm/benchmarks/readout_mitigation.py,sha256=7FlbSH-RJTtQuRYLChwkQV_vBv0ZfMQTH519cAbyxQ4,12252
 iqm/benchmarks/utils.py,sha256=MrGWVB4X037u0XZY68PtIEG8Xud3T0ZKldv2JpeLYD0,20500
 iqm/benchmarks/compressive_gst/__init__.py,sha256=LneifgYXtcwo2jcXo7GdUEHL6_peipukShhkrdaTRCA,929
-iqm/benchmarks/compressive_gst/compressive_gst.py,sha256=LyhuKCq7UvmkcDhgzRm1QuK95eepJlerxqNXuj7llxc,22146
-iqm/benchmarks/compressive_gst/gst_analysis.py,sha256=wMsomKcD5bUhfzAsi9NGw5YMkkcZ-pOFYsZvuCyGHRM,35282
+iqm/benchmarks/compressive_gst/compressive_gst.py,sha256=bG-NdSbiYTqfTGpBZtHqsjepNwUU04VB0wrqg9KH8OA,22104
+iqm/benchmarks/compressive_gst/gst_analysis.py,sha256=PxCThBfh2zdQpipI-6gAvLKdmkbYv_KSEpejltVkk7o,35330
 iqm/benchmarks/entanglement/__init__.py,sha256=9T7prOwqMmFWdb4t6ETAHZXKK5o6FvU2DvVb6WhNi-U,682
 iqm/benchmarks/entanglement/ghz.py,sha256=e97DMjH-uAuoO7cqoDS_6k7yDr-DjU9soWL2GyTgp8U,40257
 iqm/benchmarks/optimization/__init__.py,sha256=_ajW_OibYLCtzU5AUv5c2zuuVYn8ZNeZUcUUSIGt51M,747
 iqm/benchmarks/optimization/qscore.py,sha256=nkvt6zJTQclknBmUaliKP0f6Vtgvx4BvNtgVwT7W-1k,34606
 iqm/benchmarks/quantum_volume/__init__.py,sha256=i-Q4SpDWELBw7frXnxm1j4wJRcxbIyrS5uEK_v06YHo,951
 iqm/benchmarks/quantum_volume/clops.py,sha256=j6BPEj1rKBAHigox7nrvaTLyb4iCrHadBl2d1yiETDA,30956
-iqm/benchmarks/quantum_volume/quantum_volume.py,sha256=PPg1kZA5Lx9b24iFVgP_VcgymI6CsD5LfB5Ppfk8TBM,36814
+iqm/benchmarks/quantum_volume/quantum_volume.py,sha256=njX5lBty9jcWMuJnl7uNqRfwE9akMe5gcX-f1_uYDXk,36791
 iqm/benchmarks/randomized_benchmarking/__init__.py,sha256=IkKo-7zUChxZZd3my_csQCJfJfZNsV3-JTvdG8uqys4,734
 iqm/benchmarks/randomized_benchmarking/clifford_1q.pkl,sha256=vvSd0pRWxtzyirohO9yf_58mjevkc2-pbuWIEb-4gaw,46928
 iqm/benchmarks/randomized_benchmarking/clifford_2q.pkl,sha256=ZipqU3crPhz2T35qGFgB4GvMyoi_7pnu8NqW5ZP8NXg,90707258
@@ -25,7 +25,7 @@ iqm/benchmarks/randomized_benchmarking/clifford_rb/clifford_rb.py,sha256=q8bHcrV
 iqm/benchmarks/randomized_benchmarking/interleaved_rb/__init__.py,sha256=sq6MgN_hwlpkOj10vyCU4e6eKSX-oLcF2L9na6W2Gt4,681
 iqm/benchmarks/randomized_benchmarking/interleaved_rb/interleaved_rb.py,sha256=PlHn1J8VPaJF5csNH8jxcifz_MdisOEPU54kU-FYoLY,26920
 iqm/benchmarks/randomized_benchmarking/mirror_rb/__init__.py,sha256=ZekEqI_89nXzGO1vjM-b5Uwwicy59M4fYHXfA-f0MIg,674
-iqm/benchmarks/randomized_benchmarking/mirror_rb/mirror_rb.py,sha256=AmPAp80wWc_6ao4OMZBUNGX0_WlSnz9utN4436ZcjJ0,33990
+iqm/benchmarks/randomized_benchmarking/mirror_rb/mirror_rb.py,sha256=pOEnEtuJ0rMnTq5nZ1obsQ6LOIVlgFcgNGc8CULWz6E,33987
 mGST/LICENSE,sha256=TtHNq55cUcbglb7uhVudeBLUh_qPdUoAEvU0BBwFz-k,1098
 mGST/README.md,sha256=v_5kw253csHF4-RfE-44KqFmBXIsSMRmOtN0AUPrRxE,5050
 mGST/additional_fns.py,sha256=_SEJ10FRNM7_CroysT8hCLZTfpm6ZhEIDCY5zPTnhjo,31390
@@ -36,8 +36,8 @@ mGST/optimization.py,sha256=YHwkzIkYvsZOPjclR-BCQWh24jeqjuXp0BB0WX5Lwow,10559
 mGST/qiskit_interface.py,sha256=L4H-4SdhP_bjSFFvpQoF1E7EyGbIJ_CI_y4a7_YEwmU,10102
 mGST/reporting/figure_gen.py,sha256=6Xd8vwfy09hLY1YbJY6TRevuMsQSU4MsWqemly3ZO0I,12970
 mGST/reporting/reporting.py,sha256=We1cccz9BKbITYcSlZHdmBGdjMWAa1xNZe5tKP-yh_E,26004
-iqm_benchmarks-2.7.dist-info/LICENSE,sha256=2Ncb40-hqkTil78RPv3-YiJfKaJ8te9USJgliKqIdSY,11558
-iqm_benchmarks-2.7.dist-info/METADATA,sha256=b0JnI4Kl0J17rprKYuyfUcLCYsE-W9IycdJhsgMcpgQ,9506
-iqm_benchmarks-2.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-iqm_benchmarks-2.7.dist-info/top_level.txt,sha256=3G23Z-1LGf-IOzTCUl6QwWqiQ3USz25Zt90Ihq192to,9
-iqm_benchmarks-2.7.dist-info/RECORD,,
+iqm_benchmarks-2.9.dist-info/LICENSE,sha256=2Ncb40-hqkTil78RPv3-YiJfKaJ8te9USJgliKqIdSY,11558
+iqm_benchmarks-2.9.dist-info/METADATA,sha256=9ByGfYfFNY1OMBRjDm-8GQMWUGQSaBJe3a3AmSAFjUU,10170
+iqm_benchmarks-2.9.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+iqm_benchmarks-2.9.dist-info/top_level.txt,sha256=3G23Z-1LGf-IOzTCUl6QwWqiQ3USz25Zt90Ihq192to,9
+iqm_benchmarks-2.9.dist-info/RECORD,,