geocat.comp.climatologies.climatology_average#

geocat.comp.climatologies.climatology_average(dset, freq, time_dim=None)#

This function calculates long term hourly, daily, monthly, or seasonal averages across all years in the given dataset.

Parameters

dset (xarray.Dataset, xarray.DataArray) – The data on which to operate. It must be uniformly spaced in the time dimension.
freq (str) –

Frequency alias. Accepted alias:
- ‘hour’: for hourly averages
- ‘day’: for daily averages
- ‘month’: for monthly averages
- ‘season’: for meteorological seasonal averages (DJF, MAM, JJA, and SON)
time_dim (str, optional) – Name of the time coordinate for xarray objects. Defaults to None and infers the name from the data.

Returns

computed_dset (xarray.Dataset, xarray.DataArray) – The computed data

Notes

Seasonal averages are weighted based on the number of days in each month. This means that the given data must be uniformly spaced (i.e. data every 6 hours, every two days, every month, etc.) and must not cross month boundaries (i.e. don’t use weekly averages where the week falls in two different months)