fre.app.generate_time_averages.generate_time_averages module

tools for generating time averages from various packages

fre.app.generate_time_averages.generate_time_averages.generate(inf=None, outf=None, pkg=None, var=None, unwgt=False, avg_type=None)

click entrypoint to time averaging routine

fre.app.generate_time_averages.generate_time_averages.generate_time_average(infile=None, outfile=None, pkg=None, var=None, unwgt=False, avg_type=None)

steering function to various averaging functions above

Parameters:

• infile (str, list) – path to history file, or list of paths

• outfile (str) – path to where output file should be stored

• pkg (str) – which package to use to calculate climatology (cdo, fre-nctools, fre-python-tools)

• var (str) – not currently supported, defaults to none

• unwgt (bool) – wether or not to weight the data, default false

• avg_type (str) – time scale for climatology. Accepted variables vary based on pkg (‘all’,’seas’,’month’), defaults to ‘all’

Returns:

error message if requested package unkown, otherwise returns climatology

Return type:

int