Removed unnecessary GST imports in __init__.py file (#29)

* Removed unnecessary imports in __init__.py file

* Added GST imports to __init__ with try-except to avoid errors when the optional mgst dependency is not installed.

* Improved optional dependency behaviour for GST

* Linting

* Linting #2

* Improved optional dependency setup and included changelog.

CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+
+Version 2.8
+===========
+* Fixed a bug where optional dependencies related to gst were imported with other benchmarks, leading to a ModuleNotFoundError.
+
 Version 2.7
 ===========
 * Fixed bugs in Qscore and enabled benchmark execution for pyrite.

pyproject.toml

@@ -57,11 +57,9 @@ examples = [
 ]
 
 mgst = [
-    "numpy < 2.0",
-    "cvxpy == 1.5.3",
-    "pygsti == 0.9.12.3",
-    "tqdm == 4.66.5",
     "numba == 0.60.0",
+    "pygsti[diamond_norm] == 0.9.12.3",
+    "tqdm == 4.66.5",
 ]
 
 test = [

src/iqm/benchmarks/__init__.py

@@ -26,7 +26,6 @@
     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 @@
     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"

src/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 @@ def __init__(self, backend: IQMBackendBase, configuration: "GSTConfiguration"):
         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 @@ def add_configuration_to_dataset(self, dataset):  # CHECK
         # 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: