♻️ Centralize and structure code generation/infrastructure

.gitignore

@@ -182,3 +182,8 @@ node_modules/
 wheelhouse/
 
 pytest.ini
+
+# Artifacts written to the repo root by some tests/examples
+/res
+/results/
+/schedule_*.pkl

docs/AnalogInfo.md

@@ -19,14 +19,14 @@ The {code}`results` directory contains the results used in the paper {cite:label
 
 ## Codes
 
-The {code}`codes` directory contains the parity-check matrices of the codes used in the paper {cite:labelpar}`berent2023analog`.
+The parity-check matrices of the codes used in the paper {cite:labelpar}`berent2023analog` can be found in the directory {code}`src/mqt/qecc/codes/instances/lifted_product`.
 Three dimensional toric codes can either be constructed with the hypergraph product construction
 or with a library, e.g., panqec {cite:labelpar}`huang2023panceq`.
 
 ## Code construction
 
 The {code}`code_construction` directory contains the code used to construct higher-dimensional hypergraph
-product codes and used the {code}`compute_distances.sh` script to automatically compute bounds on the
+product codes, utilizing the generator {code}`src/mqt/qecc/codes/constructions/hypergraph_product_code.py`, and used the {code}`compute_distances.sh` script to automatically compute bounds on the
 distances of the constructed codes using the GAP library QDistRnd {cite:labelpar}`pryadko2023qdistrnd`.
 
 ## Utils

docs/ExactSynthesis.md

@@ -34,7 +34,7 @@ Let us synthesize an encoder for the $[[4,2,2]]$ iceberg code — a small CSS co
 
 ```{code-cell} ipython3
 from mqt.qecc.codes import construct_iceberg_code
-from mqt.qecc.codes.pauli import CheckMatrix
+from mqt.qecc.codes.core.pauli import CheckMatrix
 
 code = construct_iceberg_code(2)  # [[4,2,2]] iceberg code
 print(f"[[{code.n},{code.k},{code.distance}]] iceberg code")
@@ -97,7 +97,7 @@ For non-CSS stabilizer codes, encoding circuits are built from the full Clifford
 The gate set for non-CSS synthesis defaults to $\{H, S, \text{CX}\}$ (standard Clifford). The extended gate set $\{H, S, \sqrt{X}, \text{CX}, \text{CZ}\}$ can find shorter circuits:
 
 ```{code-cell} ipython3
-from mqt.qecc.codes.pauli import StabilizerTableau
+from mqt.qecc.codes.core.pauli import StabilizerTableau
 from mqt.qecc.circuit_synthesis.exact import get_clifford_extended_gate_set
 
 stabs = ["XZZXI", "IXZZX", "XIXZZ", "ZXIXZ"]

examples/add_new_gate_example.py

@@ -29,7 +29,7 @@
     SymbolicGateOperation,
     get_standard_clifford_gate_set,
 )
-from mqt.qecc.codes.pauli import StabilizerTableau
+from mqt.qecc.codes.core.pauli import StabilizerTableau
 
 if TYPE_CHECKING:
     import numpy as np