Kickmix

Kickmix is a library for building and simulating quantum circuits that contain classically reversible operations (like the CCX gate), phasing operations (like the Z gate), and X basis demolition measurement (the Hadamard+Measure+Reset gate sequence). See the kickmix circuit file format (v2) and the kickmix instruction set for more information.

Also see the kickmix api reference.

Example usage:

import random
import tempfile

import kickmix as km

# Build a circuit.
builder = km.CircuitBuilder()
target = builder.create_quantum_register(10, "target")
offset = builder.create_quantum_register(10, "offset")
extra = builder.create_quantum_register(1, "extra")[0]
builder.ccx(target[0], offset[0], extra)
builder.iadd(target=target, offset=offset)
circuit = builder.finish_circuit()

# Simulate the circuit on 100 randomly chosen cases.
sim = km.Simulator(batch_size=100)
sim.use_same_registers_as(circuit)
sim.clear_for_shot()
offsets = [random.randrange(2**10) for _ in range(100)]
targets = [random.randrange(2**10) for _ in range(100)]
for k in range(100):
    sim.write_within_shot("offset", k, offsets[k])
    sim.write_within_shot("target", k, targets[k])
    sim.write_within_shot("extra", k, 0)
sim.do(circuit)

# Check that the registers ended with the correct values.
for k in range(100):
    assert sim.read_within_shot("offset", k, out=int) == offsets[k]
    assert sim.read_within_shot("target", k, out=int) == (offsets[k] + targets[k]) % 2**10
    assert sim.read_within_shot("extra", k, out=int) == offsets[k] & targets[k] & 1

# Check that there's no phase errors.
assert sim.read_phase_flipped_across_shots(out=int) == 0

# Output the circuit.
with tempfile.NamedTemporaryFile() as path:
    circuit.to_file(path, format="kmx")
print(circuit.text_diagram())

which prints:

 q0: -target[0]-@-----@----------------------------------------------------------------------@-----X-
                |     |                                                                      |     |
 q1: -target[1]-|-----|-X---@-----------------------------------------------@-----X-X--------|-----|-
                |     | |   |                                               |     | |        |     |
 q2: -target[2]-|-----|-|---|---X---@--------------------@-----X-X----------|-----|-|--------|-----|-
                |     | |   |   |   |                    |     | |          |     | |        |     |
 q3: -target[3]-|-----|-|---|---|---|---X-@-X-X----------|-----|-|----------|-----|-|--------|-----|-
                |     | |   |   |   |   | | | |          |     | |          |     | |        |     |
 q4: -target[4]-|-X---|-|---|---|---|---X-X-|-|----------|-----|-|----------|-----|-|--------|-----|-
                | |   | |   |   |   |   | | | |          |     | |          |     | |        |     |
 q5: -offset[0]-@-|---@-|---|---|---|---|-|-|-|----------|-----|-|----------|-----|-|--------Z**b0-@-
                | |   | |   |   |   |   | | | |          |     | |          |     | |
 q6: -offset[1]-|-|---|-X---@---|---|---|-|-|-|----------|-----|-|----------Z**b0-@-X----------------
                | |   | |   |   |   |   | | | |          |     | |                  |
 q7: -offset[2]-|-|---|-|---|---X---@---|-|-|-|----------Z**b0-@-X------------------|----------------
                | |   | |   |   |   |   | | | |                  |                  |
 q8: -offset[3]-|-|---|-|---|---|---|---X-@-@-X------------------|------------------|----------------
                | |   | |   |   |   |   |     |                  |                  |
 q9: -offset[4]-|-@---|-|---|---|---|---|-----|------------------|------------------|----------------
                |     | |   |   |   |   |     |                  |                  |
q10: -extra[0]--X-----|-|---|---|---|---|-----|------------------|------------------|----------------
                      | |   |   |   |   |     |                  |                  |
q11:              |0>-X-@---|-X-@---|-X-@-----@-X----------------@-X----------------@-HMR=b0
                            | |     | |         |                  |
q12:                    |0>-X-@-----|-|---------|------------------@-HMR=b0
                                    | |         |
q13:                            |0>-X-@---------@-HMR=b0