Overview¶
The Python layer in QXel is organized around a small set of subsystems:
QXel.provider.braketadapts the simulators to the AWS BraketLocalSimulatorinterface and translates Braket IR into internal QXel operators, observables, and result descriptors.QXel.simulator,QXel.simulation, andQXel.transpilerimplement the high-level execution flow from circuit lowering through backend-specific execution plans.QXel.operator,QXel.observable,QXel.result,QXel.tensor, andQXel.typesexpose the typed building blocks backed by the native extension.QXel.core,QXel.distributed,QXel.functional, andQXel.loggingprovide runtime services such as device selection, MPI collectives, kernel dispatch, and rank-aware logging.QXel.benchmarkcontains benchmark runners and helper scripts used to exercise the package against external circuit suites.
Reference generation notes¶
The Sphinx reference intentionally excludes two categories of source:
src/QXel/benchmark/mqt-bench/, which vendors an external benchmark project that already carries its own documentation.src/QXel/provider/braket/openqasm/parser/generated/, which contains ANTLR-generated parser modules better treated as build artifacts than hand-authored API surfaces.