Improve argument structure in Detectors.from_layouts (#392)

Author: MarcSerraPeralta

README.md

@@ -40,7 +40,7 @@ from surface_sim.experiments.rot_surface_code_css import memory_experiment
 # prepare the layout, model, and detectors objects
 layout = rot_surface_code(distance=3)
 model = CircuitNoiseModel(layout.qubit_inds)
-detectors = Detectors(layout.anc_qubits, frame="pre-gate")
+detectors = Detectors.from_layouts(layout)
 
 # create a memory experiment
 NUM_ROUNDS = 10
@@ -91,7 +91,7 @@ circuit = stim.Circuit(
 
 layouts = unrot_surface_codes(circuit.num_qubits, distance=3)
 model = CircuitNoiseModel.from_layouts(*layouts)
-detectors = Detectors.from_layouts("pre-gate", *layouts)
+detectors = Detectors.from_layouts(*layouts, frame="pre-gate")
 
 model.setup.set_var_param("prob", 1e-3)
 

surface_sim/detectors/detectors.py

@@ -84,8 +84,8 @@ def __init__(
     @classmethod
     def from_layouts(
         cls: type[Detectors],
-        frame: str,
         *layouts: Layout,
+        frame: str = "pre-gate",
         include_gauge_dets: bool = False,
     ) -> "Detectors":
         """Creates a ``Detectors`` object using the information from the layouts.

tests/experiments/test_arbitrary_experiment.py

@@ -155,7 +155,7 @@ def test_experiment_from_schedule():
         """
     )
     model = NoiselessModel.from_layouts(*layouts)
-    detectors = Detectors.from_layouts("pre-gate", *layouts)
+    detectors = Detectors.from_layouts(*layouts, frame="pre-gate")
 
     schedule = schedule_from_circuit(circuit, layouts, gate_to_iterator)
     experiment = experiment_from_schedule(
@@ -199,7 +199,9 @@ def test_experiment_from_schedule_no_gauge_detectors():
         """
     )
     model = NoiselessModel.from_layouts(*layouts)
-    detectors = Detectors.from_layouts("pre-gate", *layouts, include_gauge_dets=False)
+    detectors = Detectors.from_layouts(
+        *layouts, frame="pre-gate", include_gauge_dets=False
+    )
 
     schedule = schedule_from_circuit(circuit, layouts, gate_to_iterator)
     experiment = experiment_from_schedule(
@@ -223,7 +225,7 @@ def test_module_2_operations_in_detectors():
     layouts = unrot_surface_codes(2, distance=3)
     model = CircuitNoiseModel.from_layouts(*layouts)
     model.setup.set_var_param("prob", 1e-3)
-    detectors = Detectors.from_layouts("pre-gate", *layouts)
+    detectors = Detectors.from_layouts(*layouts, frame="pre-gate")
 
     circuit = stim.Circuit(
         """
@@ -265,7 +267,7 @@ def test_noiseless_decorator():
     layouts = unrot_surface_codes(2, distance=3)
     model = CircuitNoiseModel.from_layouts(*layouts)
     model.setup.set_var_param("prob", 1e-3)
-    detectors = Detectors.from_layouts("pre-gate", *layouts)
+    detectors = Detectors.from_layouts(*layouts, frame="pre-gate")
 
     noisy_schedule = [
         [
@@ -295,7 +297,7 @@ def test_noiseless_decorator():
     layouts = unrot_surface_codes(2, distance=3)
     model = CircuitNoiseModel.from_layouts(*layouts)
     model.setup.set_var_param("prob", 1e-3)
-    detectors = Detectors.from_layouts("pre-gate", *layouts)
+    detectors = Detectors.from_layouts(*layouts, frame="pre-gate")
 
     noiseless_schedule = [
         [

tests/experiments/test_templates.py

@@ -628,7 +628,7 @@ def test_repeated_cnot_experiments():
     for layouts, repeated_cnot_experiment in TESTS:
         layout_c, layout_t = layouts
         model = NoiselessModel.from_layouts(*layouts)
-        detectors = Detectors.from_layouts("post-gate", *layouts)
+        detectors = Detectors.from_layouts(*layouts, frame="post-gate")
 
         # standard experiment in both basis
         for rot_basis in [True, False]:
@@ -666,7 +666,7 @@ def test_repeated_cnot_experiments():
 
         # build for some specific detectors
         detectors = Detectors.from_layouts(
-            "post-gate", *layouts, include_gauge_dets=True
+            *layouts, frame="post-gate", include_gauge_dets=True
         )
         circuit = repeated_cnot_experiment(
             model=model,
@@ -696,7 +696,7 @@ def test_repeated_cnot_experiments():
 
         # without gauge detectors
         detectors = Detectors.from_layouts(
-            "post-gate", *layouts, include_gauge_dets=False
+            *layouts, frame="post-gate", include_gauge_dets=False
         )
         circuit = repeated_cnot_experiment(
             model=model,
@@ -750,7 +750,7 @@ def test_repeated_s_injection_experiment():
     for layouts, repeated_s_injection_experiment in TESTS:
         layout, layout_anc = layouts
         model = NoiselessModel.from_layouts(*layouts)
-        detectors = Detectors.from_layouts("post-gate", *layouts)
+        detectors = Detectors.from_layouts(*layouts, frame="post-gate")
 
         # standard experiment in both basis
         for rot_basis in [True, False]:
@@ -786,7 +786,7 @@ def test_repeated_s_injection_experiment():
 
         # build for some specific detectors
         detectors = Detectors.from_layouts(
-            "post-gate", *layouts, include_gauge_dets=True
+            *layouts, frame="post-gate", include_gauge_dets=True
         )
         circuit = repeated_s_injection_experiment(
             model=model,
@@ -823,7 +823,7 @@ def test_repeated_s_injection_experiment():
 
         # without gauge detectors
         detectors = Detectors.from_layouts(
-            "post-gate", *layouts, include_gauge_dets=False
+            *layouts, frame="post-gate", include_gauge_dets=False
         )
         circuit = repeated_s_injection_experiment(
             model=model,

tests/experiments/test_templates_mid_cycle.py

@@ -113,7 +113,7 @@ def test_repeated_cnot_experiments():
     for layouts, repeated_cnot_experiment in TESTS:
         layout_c, layout_t = layouts
         model = NoiselessModel.from_layouts(*layouts)
-        detectors = Detectors.from_layouts("post-gate", *layouts)
+        detectors = Detectors.from_layouts(*layouts, frame="post-gate")
 
         # standard experiment in both basis
         for rot_basis in [True, False]:
@@ -151,7 +151,7 @@ def test_repeated_cnot_experiments():
 
         # build for some specific detectors
         detectors = Detectors.from_layouts(
-            "post-gate", *layouts, include_gauge_dets=True
+            *layouts, frame="post-gate", include_gauge_dets=True
         )
         circuit = repeated_cnot_experiment(
             model=model,
@@ -181,7 +181,7 @@ def test_repeated_cnot_experiments():
 
         # without gauge detectors
         detectors = Detectors.from_layouts(
-            "post-gate", *layouts, include_gauge_dets=False
+            *layouts, frame="post-gate", include_gauge_dets=False
         )
         circuit = repeated_cnot_experiment(
             model=model,

tests/test_readme_example.py

@@ -7,7 +7,7 @@ def test_readme_example_memory_experiment():
     # prepare the layout, model, and detectors objects
     layout = rot_surface_code(distance=3)
     model = CircuitNoiseModel(layout.qubit_inds)
-    detectors = Detectors(layout.anc_qubits, frame="pre-gate")
+    detectors = Detectors.from_layouts(layout)
 
     # create a memory experiment
     NUM_ROUNDS = 10
@@ -60,7 +60,7 @@ def test_readme_example_arbitrary_circuit():
 
     layouts = unrot_surface_codes(circuit.num_qubits, distance=3)
     model = CircuitNoiseModel.from_layouts(*layouts)
-    detectors = Detectors.from_layouts("pre-gate", *layouts)
+    detectors = Detectors.from_layouts(*layouts, frame="pre-gate")
 
     model.setup.set_var_param("prob", 1e-3)