Re-organise backend file structure (#163)

This PR re-organise the backend code in order to have a more meaningful structure. Fixes #134
QCHackers · Feb 29, 2024 · ad4f513 · ad4f513
1 parent 1a54dfb
commit ad4f513
Show file tree

Hide file tree

Showing 27 changed files with 39 additions and 302 deletions.
diff --git a/src/tqec/__init__.py b/src/tqec/__init__.py
@@ -1,29 +1,17 @@
 from . import (
-    detectors,
-    generation,
+    circuit,
     noise_models,
     plaquette,
     templates,
 )
 from ._version import __version__
-from .detectors import (
-    RelativeMeasurementData,
-    make_detector,
-    make_observable,
-    make_shift_coords,
-    transform_to_stimcirq_compatible,
-)
-from .display import (
-    display_template,
-    display_templates_svg,
-)
+from .circuit import generate_circuit
 from .enums import (
     CornerPositionEnum,
     PlaquetteOrientation,
     TemplateRelativePositionEnum,
 )
 from .exceptions import TQECException
-from .generation import generate_circuit
 from .noise_models import (
     AfterCliffordDepolarizingNoise,
     AfterResetFlipNoise,
@@ -60,4 +48,6 @@
     ScalableCorner,
     Template,
     TemplateWithIndices,
+    display_template,
+    display_templates_svg,
 )
diff --git a/src/tqec/circuit/__init__.py b/src/tqec/circuit/__init__.py
@@ -0,0 +1,8 @@
+from .circuit import generate_circuit
+from .operations import (
+    RelativeMeasurementData,
+    make_detector,
+    make_observable,
+    make_shift_coords,
+    transform_to_stimcirq_compatible,
+)
diff --git a/src/tqec/generation/circuit.py → src/tqec/circuit/circuit.py b/src/tqec/generation/circuit.py → src/tqec/circuit/circuit.py
@@ -3,9 +3,10 @@
 from copy import deepcopy
 
 import cirq
+
+from tqec.circuit.schedule import ScheduledCircuit, merge_scheduled_circuits
 from tqec.exceptions import TQECException
 from tqec.plaquette.plaquette import Plaquette
-from tqec.plaquette.schedule import ScheduledCircuit, merge_scheduled_circuits
 from tqec.position import Displacement
 from tqec.templates.base import Template
 

diff --git a/src/tqec/generation/circuit_test.py → src/tqec/circuit/circuit_test.py b/src/tqec/generation/circuit_test.py → src/tqec/circuit/circuit_test.py
@@ -2,9 +2,9 @@
 
 import cirq
 
-from tqec.detectors.operation import make_shift_coords
+from tqec.circuit.circuit import generate_circuit
+from tqec.circuit.operations.operation import make_shift_coords
 from tqec.enums import PlaquetteOrientation
-from tqec.generation.circuit import generate_circuit
 from tqec.plaquette.library import (
     MeasurementRoundedPlaquette,
     MeasurementSquarePlaquette,

diff --git a/src/tqec/detectors/__init__.py → src/tqec/circuit/operations/__init__.py b/src/tqec/detectors/__init__.py → src/tqec/circuit/operations/__init__.py
diff --git a/src/tqec/detectors/measurement_map.py → ...qec/circuit/operations/measurement_map.py b/src/tqec/detectors/measurement_map.py → ...qec/circuit/operations/measurement_map.py
@@ -1,7 +1,8 @@
 from __future__ import annotations
 
 import cirq
-from tqec.detectors.operation import RelativeMeasurementsRecord
+
+from tqec.circuit.operations.operation import RelativeMeasurementsRecord
 from tqec.exceptions import TQECException
 
 

diff --git a/src/tqec/detectors/operation.py → src/tqec/circuit/operations/operation.py b/src/tqec/detectors/operation.py → src/tqec/circuit/operations/operation.py
diff --git a/src/tqec/detectors/transformer.py → src/tqec/circuit/operations/transformer.py b/src/tqec/detectors/transformer.py → src/tqec/circuit/operations/transformer.py
@@ -6,11 +6,12 @@
 import numpy
 import stimcirq
 import sympy
-from tqec.detectors.measurement_map import (
+
+from tqec.circuit.operations.measurement_map import (
     CircuitMeasurementMap,
     compute_global_measurements_lookback_offsets,
 )
-from tqec.detectors.operation import (
+from tqec.circuit.operations.operation import (
     STIM_TAG,
     Detector,
     Observable,

diff --git a/src/tqec/plaquette/schedule.py → src/tqec/circuit/schedule.py b/src/tqec/plaquette/schedule.py → src/tqec/circuit/schedule.py
@@ -5,7 +5,8 @@
 from copy import deepcopy
 
 import cirq
-from tqec.detectors.operation import Detector, make_detector
+
+from tqec.circuit.operations.operation import Detector, make_detector
 from tqec.exceptions import TQECException
 
 

diff --git a/src/tqec/generation/__init__.py b/src/tqec/generation/__init__.py
diff --git a/src/tqec/generation/topology.py b/src/tqec/generation/topology.py
diff --git a/src/tqec/non_template_scaling/__init__.py b/src/tqec/non_template_scaling/__init__.py
diff --git a/src/tqec/non_template_scaling/animated_shape_display.py b/src/tqec/non_template_scaling/animated_shape_display.py
diff --git a/src/tqec/non_template_scaling/display_data.py b/src/tqec/non_template_scaling/display_data.py
diff --git a/src/tqec/non_template_scaling/non_template_scaling.py b/src/tqec/non_template_scaling/non_template_scaling.py
diff --git a/src/tqec/plaquette/__init__.py b/src/tqec/plaquette/__init__.py
@@ -4,7 +4,7 @@
     SquarePlaquette,
 )
 from .qubit import PlaquetteQubit
-from .schedule import (
+from ..circuit.schedule import (
     ScheduledCircuit,
     ScheduleException,
 )
diff --git a/src/tqec/plaquette/library/empty.py b/src/tqec/plaquette/library/empty.py
@@ -1,7 +1,7 @@
 import cirq
 from tqec.enums import PlaquetteOrientation
 from tqec.plaquette.plaquette import RoundedPlaquette, SquarePlaquette
-from tqec.plaquette.schedule import ScheduledCircuit
+from tqec.circuit.schedule import ScheduledCircuit
 
 
 class EmptySquarePlaquette(SquarePlaquette):