Skip to content

Squin to stim

SquinToStimPass dataclass 

SquinToStimPass(insert_ticks: bool = False)

Bases: Pass


              flowchart TD
              bloqade.stim.passes.squin_to_stim.SquinToStimPass[SquinToStimPass]

              

              click bloqade.stim.passes.squin_to_stim.SquinToStimPass href "" "bloqade.stim.passes.squin_to_stim.SquinToStimPass"

Lower a squin kernel into the STIM dialect.

insert_ticks class-attribute instance-attribute 

insert_ticks: bool = False

Insert a TICK after every gate, reset, measurement, and noise operation so the emitted Stim circuit preserves the authored execution-order layering (one moment per step) instead of being ASAP-packed when rendered as a diagram. TICK is a timing-only annotation, so enabling this does not change measurement-record or detector/observable indexing. Default off to keep existing Stim output unchanged.

unsafe_run 

unsafe_run(mt: Method) -> RewriteResult

Run the squin-to-stim lowering rewrites in place on mt.

Source code in .venv/lib/python3.12/site-packages/bloqade/stim/passes/squin_to_stim.py 
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def unsafe_run(self, mt: Method) -> RewriteResult:
    """Run the squin-to-stim lowering rewrites in place on ``mt``."""
    rewrite_result = Flatten(dialects=mt.dialects, no_raise=self.no_raise).fixpoint(
        mt
    )

    validation = StimFromSquinValidation()
    _, validation_errors = validation.run(mt)
    if validation_errors:
        raise ValidationErrorGroup(
            f"Stim from Squin validation failed with {len(validation_errors)} error(s)",
            errors=validation_errors,
        )

    address_analysis = AddressAnalysis(dialects=mt.dialects)
    addresses = address_analysis.run(mt)[0].entries

    # --- prepare hints + analyses ---
    hint_const_in_loops = HintConstInLoops(self.dialects, no_raise=self.no_raise)
    rewrite_result = hint_const_in_loops.unsafe_run(mt).join(rewrite_result)

    # Assign canonical observable indices once so partial and resolve
    # rewrites share a namespace.
    obs_idx_frame, _ = ObservableIdxAnalysis(dialects=mt.dialects).run(mt)

    # --- partial rewrites (inject GetRecIdx helpers) ---
    rewrite_result = (
        Walk(
            Chain(
                SetDetectorPartial(),
                SetObservablePartial(obs_idx_frame=obs_idx_frame),
                IfToStimPartial(address_analysis=addresses),
            )
        )
        .rewrite(mt.code)
        .join(rewrite_result)
    )

    # --- dialect conversions ---
    rewrite_result = (
        Chain(
            Walk(SquinNoiseToStim(address_analysis=addresses)),
            Walk(SquinU3ToClifford()),
            Walk(SquinResetToStim(address_analysis=addresses)),
            Walk(SquinGateToStim(address_analysis=addresses)),
        )
        .rewrite(mt.code)
        .join(rewrite_result)
    )

    # Re-hint after partial rewrites created new py.Constant stmts.
    rewrite_result = hint_const_in_loops.unsafe_run(mt).join(rewrite_result)

    # --- measurement ID analysis ---
    analysis_dialects = mt.dialects.add(record_idx_helper_dialect)
    rewrite_result = (
        StimHintConst(analysis_dialects, no_raise=self.no_raise)
        .unsafe_run(mt)
        .join(rewrite_result)
    )
    meas_analysis_frame = MeasurementIDAnalysis(dialects=analysis_dialects).run(mt)[
        0
    ]

    # --- resolve record indices + remaining conversions ---
    rewrite_result = (
        Chain(
            Walk(ResolveGetRecIdx(measure_id_frame=meas_analysis_frame)),
            Walk(
                ResolveSetAnnotate(
                    measure_id_frame=meas_analysis_frame,
                    obs_idx_frame=obs_idx_frame,
                )
            ),
            Fixpoint(Walk(DeadCodeElimination())),
            Walk(SquinMeasureToStim(address_analysis=addresses)),
        )
        .rewrite(mt.code)
        .join(rewrite_result)
    )

    rewrite_result = (
        CanonicalizeIList(dialects=mt.dialects, no_raise=self.no_raise)
        .unsafe_run(mt)
        .join(rewrite_result)
    )

    # --- REPEAT conversion + cleanup ---
    rewrite_result = (
        Chain(
            Walk(PyConstantToStim()),
            Walk(ScfForToRepeat()),
            Fixpoint(
                Walk(
                    Chain(
                        DeadCodeElimination(),
                        CommonSubexpressionElimination(),
                        RemoveDeadNonStimStatements(keep=stim_main),
                    )
                )
            ),
        )
        .rewrite(mt.code)
        .join(rewrite_result)
    )

    # --- optional TICK insertion (after all other rewrites) ---
    if self.insert_ticks:
        rewrite_result = Walk(InsertTicks()).rewrite(mt.code).join(rewrite_result)

    return rewrite_result