nctoolkit.DataSet.trange

DataSet.trange(self, over='time', align='right')

trange: Calculate the temporal range of all variables Useful for: monthly range, annual/yearly range, seasonal range, daily range, 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”

Examples

If you want to calculate range over all time steps. Do the following:

>>> ds.trange()

If you want to calculate the range for each year in a dataset, do this:

>>> ds.trange("year")

If you want to calculate the range for each month in a dataset, do this:

>>> ds.trange("month")

If you want to calculate the range for each month in each year in a dataset, do this:

>>> ds.trange(["year", "month"])

This method will also let you easily calculate climatologies. So, if you wanted to calculate a monthly climatological range, you would do this:

>>> ds.trange( "month")

A daily climatological range would be the following:

>>> ds.trange( "day")