Explanation¶
These pages explain concepts and guarantees that span more than one API. They are not a second API reference or a catalog of every implementation detail.
Concepts and guarantees¶
- Scalability Contract describes the supported flow for bounded recordings, lazy graphs, and materialization boundaries.
- Spectral Numerical Contracts compares amplitude, units, normalization, and dB conversion across spectral APIs.
Where to find other details¶
- Public classes, functions, methods, parameters, and return values are in the generated API Reference and their Python docstrings.
- Current operation and Recipe extension procedures are in the Contributor Guide.
- Historical xarray and immutable-state decisions are preserved in the xarray migration ADR and immutable state ADR.
- WDF implementation invariants for maintainers are reachable from the Contributing Overview, which links to the I/O contract guide.
- Operation-author implementation details belong to the Frame and Operation extension guide.
Use the Tutorial for a first success and How-to guides for task-specific procedures.