API Overview

The reference pages group the main EDKit APIs by subsystem.

Use the manual when you want conceptual guidance or workflow advice. Use this section when you need exact names, signatures, or a quick reminder of the relevant entry points.

For the most detailed semantics of arguments, return values, invariants, and internal helper roles, read the source-level docstrings in src/. The Documenter reference pages expose those docstrings, but the source files remain the authoritative implementation-facing layer.

Reference Map

• Bases: basis types, indexing, and high-level sector constructors
• Operators: operator construction, local spin helpers, matrix conversion
• Maps: DoubleBasis and symmetrizer
• Entanglement: entropy and Schmidt-related tools
• ITensors: MPS, MPO, Pauli, and TEBD helpers
• Lindblad: open-system and quadratic workflows
• Utilities: spectral statistics and small helper routines