pastas.utils.frequency_is_supported#

frequency_is_supported(freq)[source]#

Method to determine if a frequency is supported for a Pastas model.

Parameters

freq (str) –

Returns

String with the simulation frequency

Return type

freq

Notes

Possible frequency-offsets are listed in: http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases The frequency can be a multiple of these offsets, like ‘7D’. Because of the use in convolution, only frequencies with an equidistant offset are allowed. This means monthly (‘M’), yearly (‘Y’) or even weekly (‘W’) frequencies are not allowed. Use ‘7D’ for a weekly simulation.

D calendar day frequency H hourly frequency T, min minutely frequency S secondly frequency L, ms milliseconds U, us microseconds N nanoseconds

TODO: Rename to get_frequency_string and change Returns-documentation