API Reference

This section documents the API of the tqec package.

Modules

A list of structural modules in the package. Some of the functions and classes in the submodules are imported into the tqec namespace and can be accessed at the top level.

templates	Defines several scalable arrays of numbers used to tile plaquettes.
plaquette	Defines all the necessary data-structures to represent a plaquette.
circuit	Defines core classes and functions to represent and manipulate quantum circuits.
computation	Defines the data structures to represent the logical computations.
compile	Provides classes and functions to compile a BlockGraph instance into a stim.Circuit.
gallery	Collection of pre-built logical computations.
interop	Provides interoperability between tqec and external frameworks / formats.
simulation	Defines several helper methods to facilitate QEC circuit simulation.
utils	Defines a few core data-structures that are independent of other tqec modules.