pyfes.core.evaluate_tide(tidal_model: pyfes.core.AbstractTidalModelComplex64 | pyfes.core.AbstractTidalModelComplex128, date: VectorDateTime64, leap_seconds: VectorUInt16, longitude: VectorFloat64, latitude: VectorFloat64, settings: pyfes.core.Settings | None = None, num_threads: int = 0) → Tuple[VectorFloat64, VectorFloat64, VectorFloat8]#

Ocean tide calculation.

Parameters:

  • tidal_model – Tidal model used to interpolate the modelized waves

  • date – Date of the tide calculation

  • leap_seconds – Leap seconds at the date of the tide calculation

  • longitude – Longitude in degrees for the position at which the tide is calculated

  • latitude – Latitude in degrees for the position at which the tide is calculated

  • settings – Settings for the tide computation.

  • num_threads – Number of threads to use for the computation. If 0, the number of threads is automatically determined.

Returns:

A tuple of three elements that contains:

  • The height of the the diurnal and semi-diurnal constituents of the tidal spectrum (cm)

  • The height of the long period wave constituents of the tidal spectrum (cm)

  • The quality flag indicating the reliability of the tide calculation at the given position:

    • 0: the tide is undefined (no model data available at the given position).

    • Positive values: the tide is interpolated at the given position using N data points (where N is the number of data points used for the interpolation).

    • Negative values: the tide is extrapolated at the given position using -N data points (where N is the number of data points used for the extrapolation).

Note

Computed height of the diurnal and semi-diurnal constituents is set to nan if no data is available at the given position. The long period wave constituents is always computed because this value does not depend on model data.

pyfes.core.evaluate_equilibrium_long_period(dates: VectorDateTime64, leap_seconds: VectorUInt16, latitudes: VectorFloat64, settings: pyfes.core.Settings | None = None, num_threads: int = 0) → VectorFloat64#

Compute the long-period equilibrium ocean tides.

Parameters:

  • dates – Dates of the tide calculation

  • leap_seconds – Leap seconds at the date of the tide calculation

  • latitudes – Latitude in degrees for the position at which the long-period tide is calculated

  • settings – Settings for the tide computation.

  • num_threads – Number of threads to use for the computation. If 0, the number of threads is automatically determined.

Returns:

The computed long-period tide, in centimeters.

Contents