wavy.modelmod

The main task of this module is to acquire, read, and prepare geophysical variables from model output files for further use.

Module Contents

Classes

model_class

class to read and process model data

Functions

get_model_filedate(model, fc_date, leadtime)	get init_date for latest model output file and checks if available
make_model_filename(model, fc_date, leadtime)	creates/returns filename based on fc_date,leadtime
make_model_filename_wrapper(model, fc_date, leadtime)	Wrapper function of make_model_filename. Organizes various cases.
make_list_of_model_filenames(model, fc_dates, lt)	return: flst - list of model files to be opened
read_model_nc_output_lru(filestr, lonsname, latsname, ...)
read_model_nc_output(filestr, lonsname, latsname, timename)
get_model_fc_mode(filestr, model, fc_date[, varalias])	fct to retrieve model data for correct time
generate_bestguess_leadtime(model, fc_date[, lidx])	fct to return leadtimes for bestguess
get_model([model, sdate, edate, date_incr, fc_date, ...])	toplevel function to get model data

Attributes

model_dict
variable_info

wavy.modelmod.get_model_filedate(model, fc_date, leadtime)

get init_date for latest model output file and checks if available

param:

model - modelname type(str) fc_date - datetime object leadtime - integer in hours

return:

suitable datetime to create model filename

wavy.modelmod.make_model_filename(model, fc_date, leadtime)

creates/returns filename based on fc_date,leadtime

param: model - modelname type(str) fc_date - datetime object leadtime - integer in hours

return:

filename (consists of path + filename)

comment:

• special characters are escaped by adding “"

• the escapes need to be removed for certain libraries like xarray and netCDF4

wavy.modelmod.make_model_filename_wrapper(model, fc_date, leadtime, max_lt=None)

Wrapper function of make_model_filename. Organizes various cases.

param:

model - modelname type(str) fc_date - datetime object leadtime - integer in hours max_lt - maximum lead time allowed

return:

filename

wavy.modelmod.make_list_of_model_filenames(model, fc_dates, lt)

return: flst - list of model files to be opened

dlst - list of dates to be chosen within each file

wavy.modelmod.read_model_nc_output_lru(filestr, lonsname, latsname, timename)

wavy.modelmod.read_model_nc_output(filestr, lonsname, latsname, timename)

wavy.modelmod.get_model_fc_mode(filestr, model, fc_date, varalias=None, **kwargs)

fct to retrieve model data for correct time

wavy.modelmod.generate_bestguess_leadtime(model, fc_date, lidx=None)

fct to return leadtimes for bestguess

wavy.modelmod.get_model(model=None, sdate=None, edate=None, date_incr=None, fc_date=None, leadtime=None, varalias=None, st_obj=None, transform_lons=None)

toplevel function to get model data

wavy.modelmod.model_dict

wavy.modelmod.variable_info

class wavy.modelmod.model_class(model='mwam4', sdate=None, edate=None, date_incr=1, fc_date=None, leadtime=None, varalias='Hs', st_obj=None, transform_lons=None)

class to read and process model data model: e.g. Hs[time,lat,lon], lat[rlat,rlon], lon[rlat,rlon] This class should communicate with the satellite, model, and station classes.

get_item_parent(item, attr)

get_item_child(item)

quicklook(a=True, projection=None, date=None, **kwargs)

write_to_pickle(pathtofile=None)