API Reference

This section documents the complete public API of the pyfes package. The library is organized around a small set of high-level prediction functions that operate on tidal models and settings objects. Everything else - wave tables, astronomical angles, constituent enumerations - supports or configures those core functions.

A typical workflow involves three steps:

1. Load a tidal model (Tidal Models) from NetCDF atlas files using a configuration file.

2. Choose an engine by instantiating the appropriate Settings object (FESSettings for FES atlases, PerthSettings for GOT atlases).

3. Call a prediction function (Prediction Functions) with arrays of epochs, longitudes, and latitudes.

The remaining modules let you inspect and manipulate the underlying tidal machinery: Enumerations define the engine types, formulae, and inference methods; Astronomical Angles exposes the lunar and solar arguments; Wave System gives access to the constituent catalogue and nodal corrections; and the Engine-Specific Modules document the Darwin- and Doodson-specific internals.