pytuflow.BCTablesCheck.maximum

pytuflow.BCTablesCheck.maximum#

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

Returns the maximum values for the given locations and data types. Only time-series data is supported (i.e. data with a time index, QH boundaries are therefore not supporteD).

Parameters:

  • locations (str | list[str]) – The locations to extract the maximum values for.

  • data_types (str | list[str]) – The data types to extract the maximum values for. Can use either data type (e.g. flow) or boundary type (e.g. QT)

  • time_fmt (str, optional) – The format for the time values. Can be relative or absolute. Default is relative.

Returns:

DataFrame with the maximum values for the given locations and data types.

Return type:

pd.DataFrame

Examples

Get the maximum values for all the flow boundaries:

>>> bndry = BCTablesCheck('path/to/_bc_tables_check.csv')
>>> bndry.maximum(None, 'flow')
         QT/max  QT/tmax  SA/max  SA/tmax
FC01      92.24    0.917     NaN      NaN
Loc_002     NaN      NaN   0.814     0.75
Loc_001     NaN      NaN   1.628     0.75
Loc_004     NaN      NaN   1.221     0.75
Loc_003     NaN      NaN   1.221     0.75
Contents