iqm-benchmarks 1.9__py3-none-any.whl → 1.10__py3-none-any.whl

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/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/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.dist-info → iqm_benchmarks-1.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-benchmarks
-Version: 1.9
+Version: 1.10
 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
@@ -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.dist-info → iqm_benchmarks-1.10.dist-info}/RECORD

@@ -1,15 +1,15 @@
 iqm/benchmarks/__init__.py,sha256=7EOYlsJriQHKAlb3tHpPY4bh4wLbsssZg4NV0XW0WBU,2128
 iqm/benchmarks/benchmark.py,sha256=SGhBcSxLPUu-cVXAjG4Db2TRobFCRBYoE1NtTDK1lJg,4432
-iqm/benchmarks/benchmark_definition.py,sha256=zdsZcZm8U_C9PVhgktKPF0AX8neu-6VdWjtcCua2XEs,10310
+iqm/benchmarks/benchmark_definition.py,sha256=aRpOmeR5LOg64K6konSmko87UZ7r3uN98nkiCIOz1EU,10311
 iqm/benchmarks/benchmark_experiment.py,sha256=0BFNn04jyD1Yj-pIKnuZjCD00v3pU5EnwkRzJUBc0n4,6540
 iqm/benchmarks/logging_config.py,sha256=U7olP5Kr75AcLJqNODf9VBhJLVqIvA4AYR6J39D5rww,1052
 iqm/benchmarks/readout_mitigation.py,sha256=ugdWwdSpNoCNoqQTRBdSjzMsb9WxFQzKgGFpJmUHChE,12287
 iqm/benchmarks/utils.py,sha256=OoHDBwlr_O9PK90vwidBEFtxJa5CrOSc2suYEPpXLKE,20238
 iqm/benchmarks/compressive_gst/__init__.py,sha256=4F_5YxExn4ysGQaEs-WNfm0yiFBxkKtGAYBZFWnRsSk,915
-iqm/benchmarks/compressive_gst/compressive_gst.py,sha256=GcI9jznZFc7JIrlkVTtMgYabpTeQb_BPJ6MZlLADk-M,20678
+iqm/benchmarks/compressive_gst/compressive_gst.py,sha256=qAbAix1PhDwiPPZ82kAHIR6JN-S1oWFdwf6hxVL9ZZk,20679
 iqm/benchmarks/compressive_gst/gst_analysis.py,sha256=qaF9zDIadPGe9I0l_SC3EfnODZiykzVRxdl4Pu9zZAY,34813
 iqm/benchmarks/entanglement/__init__.py,sha256=9T7prOwqMmFWdb4t6ETAHZXKK5o6FvU2DvVb6WhNi-U,682
-iqm/benchmarks/entanglement/ghz.py,sha256=_CYVWVyFMSFsHPOFlhENXEtpezvvuKthrq7AaUTyjf4,38474
+iqm/benchmarks/entanglement/ghz.py,sha256=7Vz15n5D_qEfFaRPkSbEgAbM8aQXBMT0dkRVMIPg7jA,38470
 iqm/benchmarks/optimization/__init__.py,sha256=_ajW_OibYLCtzU5AUv5c2zuuVYn8ZNeZUcUUSIGt51M,747
 iqm/benchmarks/optimization/qscore.py,sha256=_s5_w5QTlaeDcHX1BmAevVctHOTVobee1eGkFx7DTEs,27942
 iqm/benchmarks/quantum_volume/__init__.py,sha256=i-Q4SpDWELBw7frXnxm1j4wJRcxbIyrS5uEK_v06YHo,951
@@ -36,8 +36,8 @@ mGST/optimization.py,sha256=YHwkzIkYvsZOPjclR-BCQWh24jeqjuXp0BB0WX5Lwow,10559
 mGST/qiskit_interface.py,sha256=2XuJ4WFViLsHCTpEZncwsLbRr-cELEYhegTpRPzCcuI,10080
 mGST/reporting/figure_gen.py,sha256=6Xd8vwfy09hLY1YbJY6TRevuMsQSU4MsWqemly3ZO0I,12970
 mGST/reporting/reporting.py,sha256=-XBy3OCJIMOsA8cApwKjhVKBwnjSAoxm-voHNbRWytM,25803
-iqm_benchmarks-1.9.dist-info/LICENSE,sha256=2Ncb40-hqkTil78RPv3-YiJfKaJ8te9USJgliKqIdSY,11558
-iqm_benchmarks-1.9.dist-info/METADATA,sha256=fSZa5u9cJ5NPakoKA-yBiMR6cOaC9997jAyjmIrQfZs,8771
-iqm_benchmarks-1.9.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-iqm_benchmarks-1.9.dist-info/top_level.txt,sha256=3G23Z-1LGf-IOzTCUl6QwWqiQ3USz25Zt90Ihq192to,9
-iqm_benchmarks-1.9.dist-info/RECORD,,
+iqm_benchmarks-1.10.dist-info/LICENSE,sha256=2Ncb40-hqkTil78RPv3-YiJfKaJ8te9USJgliKqIdSY,11558
+iqm_benchmarks-1.10.dist-info/METADATA,sha256=O38CwLpwADr-9si2EwCyj31aBj5_oBQykTo2T-HBD4I,9013
+iqm_benchmarks-1.10.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+iqm_benchmarks-1.10.dist-info/top_level.txt,sha256=3G23Z-1LGf-IOzTCUl6QwWqiQ3USz25Zt90Ihq192to,9
+iqm_benchmarks-1.10.dist-info/RECORD,,