WIP: FT State Preparation Through Code Symmetries

.gitignore

@@ -174,3 +174,11 @@ out/build
 
 node_modules/
 wheelhouse/
+
+pytest.ini
+
+# -----------------------------------------------------------------------------
+# Personal / local development ignore rules
+# (Feel free to add your own scratch or playground folders here)
+# -----------------------------------------------------------------------------
+playground/

scripts/ft_stateprep/canonical_steane/estimate_canonical.py

@@ -0,0 +1,82 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+"""Estimate logical error rate for CSS state preparation circuits for a given code and physical error rate."""
+
+from __future__ import annotations
+
+import argparse
+
+from mqt.qecc import CSSCode
+from mqt.qecc.circuit_synthesis import SteaneNDFTStatePrepSimulator, heuristic_prep_circuit
+from mqt.qecc.circuit_synthesis.state_prep import canonical_steane_type_prep_circuits, random_steane_type_prep_circuits
+from mqt.qecc.codes import HexagonalColorCode, SquareOctagonColorCode
+
+codes = {"golay": CSSCode.from_code_name("golay"), "hex": HexagonalColorCode(7), "sqoct": SquareOctagonColorCode(7)}
+
+
+def main() -> None:
+    """Run the logical error rate estimation for a given code and physical error rate."""
+    parser = argparse.ArgumentParser(description="Estimate logical error rate for CSS state preparation circuits")
+    parser.add_argument(
+        "code",
+        type=str,
+        help="Code for which to estimate logical error rate. Available codes: " + ", ".join(codes),
+    )
+    parser.add_argument("-p", "--p_error", type=float, help="Physical error rate")
+    parser.add_argument("-n", "--n_errors", type=int, default=500, help="Number of errors to sample")
+    parser.add_argument(
+        "--perm",
+        type=str,
+        default="canonical",
+        help="Permutation for state preparation. Can be 'canonical' or 'random'",
+    )
+    parser.add_argument(
+        "-e", "--error_type", type=str, default="X", help="Type of error to use for simulation. Can be 'X' or 'Z'."
+    )
+
+    args = parser.parse_args()
+    code_name = args.code
+    if code_name in codes:
+        code = codes[code_name]
+    else:
+        raise ValueError("Code " + code_name + " not available. Available codes: " + ", ".join(codes))
+
+    if args.perm == "canonical":
+        qc1, qc2, qc3, qc4 = canonical_steane_type_prep_circuits(code)
+        perm = "canonical"
+    elif args.perm == "random":
+        qc1, qc2, qc3, qc4, perm = random_steane_type_prep_circuits(code)
+    else:
+        raise ValueError("Permutation " + args.perm + " not available. Available permutations: 'canonical, random'")
+
+    sim = SteaneNDFTStatePrepSimulator(
+        qc1, qc2, code, qc3, qc4, check_circuit=heuristic_prep_circuit(code, zero_state=False).circ
+    )
+    sim.set_p(args.p_error, args.p_error * 0.01)
+
+    if args.error_type == "X":
+        p_l, r_a, num_logical_errors, total_shots, p_l_error, r_a_error = sim.logical_error_rate(
+            min_errors=args.n_errors
+        )
+    elif args.error_type == "Z":
+        p_l, r_a, num_logical_errors, total_shots, p_l_error, r_a_error = sim.secondary_logical_error_rate(
+            min_errors=args.n_errors
+        )
+    else:
+        msg = "Error type should be either X or Z."
+        raise ValueError(msg)
+
+    print(
+        ";".join([
+            str(x) for x in [args.p_error, p_l, r_a, num_logical_errors, total_shots, p_l_error, r_a_error, perm]
+        ])
+    )
+
+
+if __name__ == "__main__":
+    main()

scripts/ft_stateprep/canonical_steane/run_parallel.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+declare -a p=("0.001" "0.0015" "0.002" "0.0025" "0.003" "0.0035" "0.004" "0.0045" "0.005" "0.0055" "0.006" "0.0065" "0.007" "0.0075" "0.008" "0.0085" "0.009" "0.0095" "0.01")
+
+echo "p;p_l;r_a;num_logical_errors;total_shots;p_l_error;r_a_error" > "$1.csv"
+
+run_and_write() {
+    local res=$(python estimate_canonical.py ${@:2:$#-2} "-p" "${@: -1}")
+    local line="${@: -1};${res}"
+    (flock -e 200 echo $line >> "$1.csv") 200>lock
+}
+
+export -f run_and_write
+
+parallel --load 16 --link run_and_write $@ ::: ${p[@]}

scripts/ft_stateprep/eval/estimate_logical_error_rate.py

@@ -16,7 +16,7 @@
 
 from mqt.qecc import CSSCode
 from mqt.qecc.circuit_synthesis import (
-    NoisyNDFTStatePrepSimulator,
+    VerificationNDFTStatePrepSimulator,
     gate_optimal_prep_circuit,
     gate_optimal_verification_circuit,
     heuristic_prep_circuit,
@@ -98,7 +98,7 @@ def main() -> None:
         # load circuit from file
         qc = QuantumCircuit.from_qasm_file(prefix / code_name / circ_file)
 
-    sim = NoisyNDFTStatePrepSimulator(
+    sim = VerificationNDFTStatePrepSimulator(
         qc,
         code=code,
         p=args.p_error,

scripts/ft_stateprep/eval/run_d7.py

@@ -16,7 +16,7 @@
 from qiskit import QuantumCircuit
 
 from mqt.qecc.circuit_synthesis import (
-    NoisyNDFTStatePrepSimulator,
+    VerificationNDFTStatePrepSimulator,
 )
 from mqt.qecc.codes import SquareOctagonColorCode
 
@@ -38,7 +38,9 @@ def main() -> None:
     lut_path = (Path(__file__) / "../luts/decoder_488_7.pickle").resolve()
     with lut_path.open("rb") as f:
         lut = pickle.load(f)  # noqa: S301
-    sim = NoisyNDFTStatePrepSimulator(qc, code, decoder=lut, p=args.p_error, p_idle=args.p_idle_factor * args.p_error)
+    sim = VerificationNDFTStatePrepSimulator(
+        qc, code, decoder=lut, p=args.p_error, p_idle=args.p_idle_factor * args.p_error
+    )
     res = sim.logical_error_rate(min_errors=args.n_errors)
     print(",".join([str(x) for x in [args.p_error, *res]]))
 

scripts/ft_stateprep/eval_circ_mod/check_matrix/eve_20_2_6.txt

@@ -0,0 +1,18 @@
+XIIIIIIIIXIXXIXXXXII
+IXIIIIIIIXIIXXIIXXXX
+IIXIIIIIIIXXIXXIXXXI
+IIIXIIIIIIXIXXXXIXIX
+IIIIXIIIIXXIXIIIXXXX
+IIIIIXIIIXIXIIXXXXIX
+IIIIIIXIIIXXIXIXXXXI
+IIIIIIIXIXIXIIIIIIXI
+IIIIIIIIXIXIXXXXXIIX
+ZIIIIIIIIZIZZIZZZZII
+IZIIIIIIIZIIZZIIZZZZ
+IIZIIIIIIIZZIZZIZZZI
+IIIZIIIIIIZIZZZZIZIZ
+IIIIZIIIIZZIZIIIZZZZ
+IIIIIZIIIZIZIIZZZZIZ
+IIIIIIZIIIZZIZIZZZZI
+IIIIIIIZIZIZIIIIIIZI
+IIIIIIIIZIZIZZZZZIIZ

scripts/ft_stateprep/eval_circ_mod/check_matrix/flag_at_origin/cc_17_1_5.txt

@@ -0,0 +1,16 @@
+ZZZZIIIIIIIIIIIII
+IZIZIIZZIIIIIIIII
+IIIIZIIIZIIIZZIII
+IIIIZZIIZZIIIIIII
+IIZZIZZIIZZIIIZZI
+IIIIIIZZIIZZIIIII
+IIIIIIIIZZIIIZZII
+IIIIIIIIIIZZIIIZZ
+XXXXIIIIIIIIIIIII
+IXIXIIXXIIIIIIIII
+IIIIXIIIXIIIXXIII
+IIIIXXIIXXIIIIIII
+IIXXIXXIIXXIIIXXI
+IIIIIIXXIIXXIIIII
+IIIIIIIIXXIIIXXII
+IIIIIIIIIIXXIIIXX

scripts/ft_stateprep/eval_circ_mod/check_matrix/flag_at_origin/cc_20_2_6.txt

@@ -0,0 +1,18 @@
+ZZZZIIIIIIIIIIIIIIII
+IIIIZZZZIIIIIIIIIIII
+IIIIIIIIZZZZIIIIIIII
+IIIIIIIIIIIIZZZZIIII
+IIIIIIIIIIIIIIIIZZZZ
+ZIIZIIZZIIZZZIIZIIII
+IIIIZIIZIIZZIIZZZIIZ
+ZIIZIIIIZIIZIIZZIIZZ
+IIZZZIIZIIIIZIIZIIZZ
+XXXXIIIIIIIIIIIIIIII
+IIIIXXXXIIIIIIIIIIII
+IIIIIIIIXXXXIIIIIIII
+IIIIIIIIIIIIXXXXIIII
+IIIIIIIIIIIIIIIIXXXX
+XIIXIIXXIIXXXIIXIIII
+IIIIXIIXIIXXIIXXXIIX
+XIIXIIIIXIIXIIXXIIXX
+IIXXXIIXIIIIXIIXIIXX

scripts/ft_stateprep/eval_circ_mod/check_matrix/flag_at_origin/cc_25_1_5.txt

@@ -0,0 +1,24 @@
+IIIIZIIIIZIIIIIIIIIIIIIII
+IIIIIIIIIIIIIIZIIIIZIIIII
+IIIIIIIIZZIIIZZIIIIIIIIII
+IIIIIIIIIIIIIIIIIIZZIIIZZ
+IIZZIIIZZIIIIIIIIIIIIIIII
+IIIIIIIIIIIIZZIIIZZIIIIII
+IIIIIIZZIIIZZIIIIIIIIIIII
+IIIIIIIIIIIIIIIIZZIIIZZII
+ZZIIIZZIIIIIIIIIIIIIIIIII
+IIIIIIIIIIZZIIIZZIIIIIIII
+IIIIIZIIIIZIIIIIIIIIIIIII
+IIIIIIIIIIIIIIIZIIIIZIIII
+XXIIIIIIIIIIIIIIIIIIIIIII
+IIXXIIIIIIIIIIIIIIIIIIIII
+IXXIIIXXIIIIIIIIIIIIIIIII
+IIIXXIIIXXIIIIIIIIIIIIIII
+IIIIIXXIIIXXIIIIIIIIIIIII
+IIIIIIIXXIIIXXIIIIIIIIIII
+IIIIIIIIIIIXXIIIXXIIIIIII
+IIIIIIIIIIIIIXXIIIXXIIIII
+IIIIIIIIIIIIIIIXXIIIXXIII
+IIIIIIIIIIIIIIIIIXXIIIXXI
+IIIIIIIIIIIIIIIIIIIIIXXII
+IIIIIIIIIIIIIIIIIIIIIIIXX

scripts/ft_stateprep/eval_circ_mod/check_matrix/flag_at_origin/cc_31_1_7.txt

@@ -0,0 +1,30 @@
+ZIZIZZIIIIIIIIIIIIIIIIIIIIIIIII
+ZZZZIIIIIIIIIIIIIIIIIIIIIIIIIII
+IIIIZZIIZZIIIIIIIIIIIIIIIIIIIII
+IIZZIZZIIZZIIIZZIIIIIIIIIIIIIII
+IIIIIIZZIIZZIIIIIIIIIIIIIIIIIII
+IIIIIIIZIIIZIIIIZZIIIIIIIIIIIII
+IIIIIIIIIIIIZIIIIIZIIIIIZZIIIII
+IIIIIIIIIIIIZZIIIIZZIIIIIIIIIII
+IIIIIIIIZZIIIZZIIIIZZIIIIIZZIII
+IIIIIIIIIIIIIIZZIIIIZZIIIIIIIII
+IIIIIIIIIIZZIIIZZIIIIZZIIIIIZZI
+IIIIIIIIIIIIIIIIZZIIIIZZIIIIIII
+IIIIIIIIIIIIIIIIIIZZIIIIIZZIIII
+IIIIIIIIIIIIIIIIIIIIZZIIIIIZZII
+IIIIIIIIIIIIIIIIIIIIIIZZIIIIIZZ
+XIXIXXIIIIIIIIIIIIIIIIIIIIIIIII
+XXXXIIIIIIIIIIIIIIIIIIIIIIIIIII
+IIIIXXIIXXIIIIIIIIIIIIIIIIIIIII
+IIXXIXXIIXXIIIXXIIIIIIIIIIIIIII
+IIIIIIXXIIXXIIIIIIIIIIIIIIIIIII
+IIIIIIIXIIIXIIIIXXIIIIIIIIIIIII
+IIIIIIIIIIIIXIIIIIXIIIIIXXIIIII
+IIIIIIIIIIIIXXIIIIXXIIIIIIIIIII
+IIIIIIIIXXIIIXXIIIIXXIIIIIXXIII
+IIIIIIIIIIIIIIXXIIIIXXIIIIIIIII
+IIIIIIIIIIXXIIIXXIIIIXXIIIIIXXI
+IIIIIIIIIIIIIIIIXXIIIIXXIIIIIII
+IIIIIIIIIIIIIIIIIIXXIIIIIXXIIII
+IIIIIIIIIIIIIIIIIIIIXXIIIIIXXII
+IIIIIIIIIIIIIIIIIIIIIIXXIIIIIXX

scripts/ft_stateprep/eval_circ_mod/circuits/cc_4_8_8_d5/cc_4_8_8_d5_heuristic_0.qasm

@@ -0,0 +1,34 @@
+OPENQASM 2.0;
+include "qelib1.inc";
+qreg q[17];
+h q[0];
+h q[1];
+h q[2];
+h q[3];
+h q[4];
+h q[5];
+h q[9];
+h q[10];
+cx q[4],q[8];
+cx q[10],q[15];
+cx q[4],q[6];
+cx q[9],q[15];
+cx q[5],q[12];
+cx q[4],q[7];
+cx q[3],q[14];
+cx q[2],q[6];
+cx q[14],q[16];
+cx q[10],q[13];
+cx q[9],q[11];
+cx q[8],q[5];
+cx q[3],q[7];
+cx q[1],q[4];
+cx q[0],q[2];
+cx q[12],q[9];
+cx q[1],q[13];
+cx q[0],q[3];
+cx q[15],q[8];
+cx q[6],q[16];
+cx q[5],q[11];
+cx q[4],q[10];
+cx q[2],q[14];

scripts/ft_stateprep/eval_circ_mod/circuits/cc_4_8_8_d5/cc_4_8_8_d5_heuristic_1.qasm

@@ -0,0 +1,34 @@
+OPENQASM 2.0;
+include "qelib1.inc";
+qreg q[17];
+h q[0];
+h q[1];
+h q[2];
+h q[3];
+cx q[1],q[4];
+cx q[3],q[7];
+h q[8];
+cx q[8],q[5];
+cx q[8],q[7];
+cx q[5],q[11];
+cx q[11],q[4];
+h q[12];
+h q[13];
+cx q[13],q[10];
+cx q[4],q[10];
+cx q[3],q[14];
+h q[15];
+cx q[15],q[9];
+cx q[12],q[9];
+cx q[13],q[15];
+cx q[1],q[13];
+cx q[15],q[8];
+cx q[9],q[11];
+cx q[2],q[16];
+cx q[2],q[6];
+cx q[0],q[2];
+cx q[0],q[3];
+cx q[2],q[14];
+cx q[5],q[6];
+cx q[12],q[5];
+cx q[7],q[16];

scripts/ft_stateprep/eval_circ_mod/circuits/cc_4_8_8_d5/cc_4_8_8_d5_heuristic_2.qasm

@@ -0,0 +1,34 @@
+OPENQASM 2.0;
+include "qelib1.inc";
+qreg q[17];
+h q[0];
+h q[1];
+h q[2];
+h q[3];
+h q[4];
+h q[5];
+h q[9];
+h q[10];
+cx q[4],q[8];
+cx q[10],q[15];
+cx q[4],q[6];
+cx q[9],q[15];
+cx q[5],q[12];
+cx q[4],q[7];
+cx q[3],q[14];
+cx q[2],q[6];
+cx q[14],q[16];
+cx q[10],q[13];
+cx q[9],q[11];
+cx q[8],q[5];
+cx q[3],q[7];
+cx q[1],q[4];
+cx q[0],q[2];
+cx q[12],q[9];
+cx q[1],q[13];
+cx q[0],q[3];
+cx q[15],q[8];
+cx q[6],q[16];
+cx q[5],q[11];
+cx q[4],q[10];
+cx q[2],q[14];