pytuflow.LP2D.maximum

Contents

pytuflow.LP2D.maximum#

LP2D.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

The maximum() method is only applicable for points along the 2d_lp line. For the maximum profile result, use the section() method with the data type of max [data_type] e.g. max water level.

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

>>> lp = LP2D('/path/to/model_LP_NAME_H.csv')
>>> lp.maximum('EG02_012_LP_01_2.07_pnt0', 'water level')
                           point/water level/max  point/water level/tmax
EG02_012_LP_01_2.07_pnt0                  49.863                  0.9500
Contents