pytuflow.NCGrid.times

Contents

pytuflow.NCGrid.times#

NCGrid.times(filter_by=None, fmt='relative')#

Returns a list of times for the given filter.

The filter_by argument can be used to filter the times by a given data type. In most cases (out of TUFLOW) all the times are the same for all data types, so filter_by is not necessary.

Parameters:

  • filter_by (str, optional) – Filter the times by a given string.

  • fmt (str, optional) – The format for the time values. Options are ‘relative’ or ‘absolute’.

Returns:

The list of times.

Return type:

list[TimeLike]

Examples

>>> nc = NCGrid('./path/to/result.nc')
>>> nc.times()
[0.0, 0.016666666666666666, ..., 3.0]
Contents