pytuflow.FVBCTide.maximum

pytuflow.FVBCTide.maximum#

FVBCTide.maximum(locations, data_types, time_fmt='relative')#

Returns a DataFrame containing the maximum values for the given data types. The returned DataFrame will include time of maximum results as well.

It’s possible to pass in a well known shorthand for the data type e.g. h for water level.

The returned DataFrame will have an index column corresponding to the location IDs, and the columns will be in the format obj/data_type/[max|tmax], e.g. point/water level/max, point/water level/tmax

Parameters:

  • locations (str | list[str]) – The location to extract the maximum values for. None will return all locations for the given data_types.

  • data_types (str | list[str]) – The data types to extract the maximum values for. None will return all data types for the given locations.

  • time_fmt (str, optional) – The format for the time of max result. Options are relative or absolute

Returns:

The maximum, and time of maximum values

Return type:

pd.DataFrame

Examples

Extracting the maximum flow for a given channel:

>>> bndry = FVBCTide('/path/to/fv_bc_tide.nc', '/path/to/fv_bc_tide.shp')
>>> bndry.maximum('Ocean_pt_0', 'level')
            point/level/max  point/level/tmax
Ocean_pt_0         1.191989         289784.25
Contents