Curated API Reference
Below is a curated API reference for Bloqade, centered around tools used for programming for the Gemini-QEC machine.
Start with Express a program for defining a logical program with gates, followed by Exchange with other tools for helpful circuit interoperability.
To execute programs, visit Simulate for simulating the logical program, as well as Run on hardware for submitting programs for execution on Gemini.
For postprocessing and analysis tools on shot results, see Interpret results, and for debugging and visualization tools for your Gemini program, see Compile and inspect.
Express a program
Define gate-based programs.
SQUIN 54
- bloqade.squin.kernel
- bloqade.squin.qalloc
- bloqade.squin.h
- bloqade.squin.s
- bloqade.squin.t
- bloqade.squin.x
- bloqade.squin.y
- bloqade.squin.z
- bloqade.squin.cx
- bloqade.squin.cy
- bloqade.squin.cz
- bloqade.squin.rx
- bloqade.squin.ry
- bloqade.squin.rz
- bloqade.squin.u3
- bloqade.squin.cnot
- bloqade.squin.s_adj
- bloqade.squin.shift
- bloqade.squin.t_adj
- bloqade.squin.sqrt_x
- bloqade.squin.sqrt_y
- bloqade.squin.sqrt_z
- bloqade.squin.phased_xz
- bloqade.squin.sqrt_x_adj
- bloqade.squin.sqrt_y_adj
- bloqade.squin.sqrt_z_adj
- bloqade.squin.broadcast.h
- bloqade.squin.broadcast.s
- bloqade.squin.broadcast.t
- bloqade.squin.broadcast.x
- bloqade.squin.broadcast.y
- bloqade.squin.broadcast.z
- bloqade.squin.broadcast.cx
- bloqade.squin.broadcast.cy
- bloqade.squin.broadcast.cz
- bloqade.squin.broadcast.rx
- bloqade.squin.broadcast.ry
- bloqade.squin.broadcast.rz
- bloqade.squin.broadcast.u3
- bloqade.squin.broadcast.cnot
- bloqade.squin.broadcast.s_adj
- bloqade.squin.broadcast.shift
- bloqade.squin.broadcast.t_adj
- bloqade.squin.broadcast.sqrt_x
- bloqade.squin.broadcast.sqrt_y
- bloqade.squin.broadcast.sqrt_z
- bloqade.squin.broadcast.phased_xz
- bloqade.squin.broadcast.sqrt_x_adj
- bloqade.squin.broadcast.sqrt_y_adj
- bloqade.squin.broadcast.sqrt_z_adj
- bloqade.squin.set_detector
- bloqade.squin.set_observable
- bloqade.squin.measure
- bloqade.squin.broadcast.measure
Exchange with other tools
Convert Bloqade kernels to external formats.
Simulate
Run circuits locally with/without noise.
Run on hardware
Build tasks, submit jobs, and retrieve results.
Gemini 21
- bloqade.gemini.GeminiLogicalDevice
- bloqade.core.device.Device
- bloqade.core.device.TaskBuilder
- bloqade.gemini.device.logical.task
- bloqade.core.device.task.TaskABC
- bloqade.core.device.task.SingleKernelTask
- bloqade.core.device.task.ParameterScanTask
- bloqade.core.device.task.KernelBatchTask
- bloqade.gemini.device.logical.task.GeminiSingleKernelTask
- bloqade.gemini.device.logical.task.GeminiParameterScanTask
- bloqade.gemini.device.logical.task.GeminiKernelBatchTask
- bloqade.gemini.GeminiLogicalFuture
- bloqade.core.device.Future
- bloqade.gemini.GeminiLogicalResult
- bloqade.core.device.Result
- bloqade.core.device.ShotResult
- bloqade.core.device.ShotFilter
- bloqade.core.device.local_storage.StorageFilter
- bloqade.core.device.DictStorage
- bloqade.core.device.SQLiteStorage
- bloqade.core.device.local_storage.StorageBackend
Interpret results
Decode and postprocess shot data.
Compile and inspect
Steps in the compiler pipeline and visualization tools.
Full library reference
Section titled “Full library reference”We also have a full API reference below. Note that the full API reference is still in development and thus may have incomplete documentation.
Browse all libraries for the complete generated reference, including Bloqade-Analog (for programming QuEra’s Aquila machine), Kirin (for compiler infrastructure), and Vihaco (for virtual machines). If using the Bloqade package, you can see compatible package versions at the Bloqade 0.34.0 compatibility profile.