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: str | List[str] = None, outfile: str = None, pkg: str = None, var: str | None = None, unwgt: bool | None = False, avg_type: str | None = 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) – optional, not currently supported and defaults to None

• unwgt (bool) – optional, whether or not to weight the data, default False

• avg_type (str) – optional, time scale for averaging, accepts (‘all’,’seas’,’month’). defaults to ‘all’

Returns:

error message if requested package unknown, otherwise returns climatology

Return type:

int