Skip to content

API Reference

BirdDMD is organised into dataset-agnostic modules and a hawk-specific convenience layer.

Modules

Module Description
core DMDResult, run_dmd(), conjugate-pair detection, convergence analysis
data Validation, normalisation, binning, and reshaping
reconstruction reconstruct() and forecast() from fitted DMD models
stats RMSE, variance explained, and sequence filtering
plotting Dataset-agnostic DMD visualisation
hawk Hawk-specific loading, wrappers, and plots
_constants Named constants (marker positions, colours, metadata columns)