nctoolkit.DataSet.tmin#
- DataSet.tmin(over='time', align='right', window=None)#
tmin: Calculate the temporal minimum of all variables.
Useful for: monthly minimum, annual/yearly minimum, seasonal minimum, daily minimum, daily climatology, monthly climatology, seasonal climatology
- Parameters:
over (str or list) – Time periods to average over. Options are ‘year’, ‘month’, ‘day’. This operates in a similar way to the groupby method in pandas or the tidyverse in R, with over acting as the grouping.
align (str) – This determines whether the output time is at the left, centre or right hand side of the time window. Options are “left”, “centre” and “right”
window (int) – This determines the number of time steps to calculate the minimum over to calculate over, on a non-rolling basis. This is useful if you need to calculate the minimum every 5 days, for example.
Examples
If you want to calculate minimum over all time steps. Do the following:
>>> ds.tmin()
If you want to calculate the minimum for each year in a dataset, do this:
>>> ds.tmin("year")
If you want to calculate the minimum for each month in a dataset, do this:
>>> ds.tmin("month")
If you want to calculate the minimum for each month in each year in a dataset, do this:
>>> ds.tmin(["year", "month"])
This method will also let you easily calculate climatologies. So, if you wanted to calculate a monthly climatological min, you would do this:
>>> ds.tmin( "month")
A daily climatological minimum would be the following:
>>> ds.tmin( "day")