Package API map¶
Start with the root API reference. Import from the owning cascaqit.<package> when you need a custom ansatz, gradient configuration, job storage or reference compilation. The root keeps common operations accessible; a type absent from the root is not necessarily private.
The table describes each package and links to its public export declarations at this documentation version. Inspect __all__ for exported names and follow their definitions in the same commit for parameters. This page helps locate advanced APIs; complete authored member explanations currently cover the root API.
| Package and export source | Purpose and limits |
|---|---|
cascaqit.algorithms |
Ansatz definitions, gradients, optimizers and diagnostic results. Start with VQE/QAOA reference pages; import advanced types here. |
cascaqit.analog |
Atom registers, waveforms, addressing and AHS programs, including site-phase types outside the root API. |
cascaqit.backends |
Job persistence, history and backend protocols. Hardware/cloud protocol types do not connect to live services. |
cascaqit.compiler |
Public reference compilation, passes and caches. Outputs are not device execution packages from the private compiler. |
cascaqit.consistency |
Cross-package record, provenance and reference checks; these do not validate the physical model. |
cascaqit.control |
Control-channel, addressing and concurrency declarations used to express constraints. |
cascaqit.diagnostics |
Structured diagnostics, severity and source locations for programmatic error handling. |
cascaqit.digital |
Circuit construction and digital intermediate representations. Most learners should start with the root Circuit API. |
cascaqit.discretization |
Convert validated controls to a Target’s allowed grids and retain changes. |
cascaqit.hybrid |
Hybrid programs, graphs, plans and orchestration. Internal plans are not direct Backend inputs. |
cascaqit.interop |
Explicit import/export and restricted OpenQASM conversion, subject to converter validation. |
cascaqit.native_ir |
Native program, reference and compiled-result structures for storage and exchange between packages. |
cascaqit.observables |
Observable declarations, Pauli types and batch results. |
cascaqit.parameters |
Parameter declarations, expressions, schemas, bindings and scans. Unit labels do not perform implicit conversion. |
cascaqit.problems |
Graph, MIS/MWIS, QUBO/Ising, objective evaluation and problem compilation. Constraint penalties must satisfy model-specific conditions. |
cascaqit.readiness |
Check completeness of records for offline hardware/cloud submission; this does not establish device access or execution. |
cascaqit.reports |
Report bundles for offline readiness checks and related records. Use visualization for learning-experiment plots. |
cascaqit.results |
ResultIR, execution traces, views and artifact references. Reading a reference does not fetch a remote artifact. |
cascaqit.runtime |
Execution entry points, Job and batch protocols, and scheduling structures. |
cascaqit.simulators |
Local planners, state representations, evolution methods and physical noise, subject to program and resource checks. |
cascaqit.submission |
Build offline hardware-submission requests and checksums without uploading or starting hardware jobs. |
cascaqit.sweep |
Parameter grids and scan/optimization helpers. |
cascaqit.syntax |
Restricted decorator frontend, AST/HIR, source maps and lowering; arbitrary Python is not executable as a quantum program. |
cascaqit.targets |
Targets, calibration, registries and capability projection. A target declaration does not imply an available live device. |
cascaqit.validation |
Check program and target constraints and return diagnostics with locations. |
cascaqit.visualization |
Experiment reports, plot rendering and output configuration tied to saved results. |
Prefer the package’s public entry point over underscored names or internal file paths. Record the SDK version and commit for reproducibility, and use examples and documentation from that version.
For example, GradientConfig and HardwareEfficientAnsatz belong to cascaqit.algorithms; JobHistoryQuery belongs to cascaqit.backends. Constructing a configuration declares settings; execution still requires an algorithm or backend call.