meshflow.utility.forcing_prep.freq_long_name

meshflow.utility.forcing_prep.freq_long_name(freq_alias)[source]

Return the full name of a time offset alias based on pandas conventions.

Parameters:

freq_alias (str) – Time offset alias representing time interval frequency, such as ‘H’ for ‘hours’, ‘T’ for ‘minutes’, etc.

Returns:

Full name of the time offset (e.g., ‘hours’, ‘minutes’).

Return type:

str

Raises:

  • TypeError – If freq_alias is not a string.

  • ValueError – If freq_alias is not a recognized offset alias.

Examples

>>> freq_long_name('H')
'hours'
>>> freq_long_name('T')
'minutes'