def prepare_ndown(config):
"""Runs a one-way nested simulation using ndown.exe
We assume the coarse resolution run has been done,
and we have wrfout_d01.date files.
We only need to run metgrid for the initial forecast time.
We have two options, either we force the user to do all the renaming themselves,
or we allow them to utilise the original namelist.input file, and add effectivley
add a column onto that. This could be done via a bunch of smaller utility steps.
e.g. shift_namelist namelist.input 3 > namelist.input
Which would rotate the columns of a namelist.input file so that the n-th column
becomes the first column.
Therefore we have to run ungrib, geogrid, metgrid
Assume the geo_em files exist for both domains.
What """
logger =shared.get_logger()
logger.info('*** PREPARING NDOWN ***')
namelist_wps = config['namelist_wps']
namelist_input = config['namelist_input']
max_dom = config['max_dom']
wrf_run_dir = config['wrf_run_dir']
if max_dom!=2:
raise ConfigError("max_dom must equal 2 when doing ndown runs")
bdy_times = shared.get_bdy_times(config)
ndown_fmt = config['ndown_fmt']
wrfout_d01_files = [shared.sub_date(ndown_fmt, init_time=bdy_times[0], valid_time=t) for t in bdy_times]
for f in wrfout_d01_files:
if not os.path.exists(f):
raise MissingFile("File: %s missing" % f)
cmd = 'ln -sf %s %s' % (f, wrf_run_dir)
shared.run_cmd(cmd, config)
# Check for wrfinput_d02
wrfinput_d02 = '%s/wrfinput_d02' % wrf_run_dir
if not os.path.exists(wrfinput_d02):
raise MissingFile("wrfinput_d02 is missing")
os.rename('%s/wrfinput_d02' % wrf_run_dir, '%s/wrfndi_d02' % wrf_run_dir)
namelist = read_namelist(namelist_input)
# History interval is in minutes
history_interval = namelist.settings['history_interval']
interval_seconds = history_interval[0] * 60
namelist.update('interval_seconds', interval_seconds)
namelist.insert('io_form_auxinput2', 2, 'time_control')
namelist.to_file(namelist_input)
logger.info('*** DONE PREPARE NDOWN ***')
def prepare_ndown(config):
"""Runs a one-way nested simulation using ndown.exe
We assume the coarse resolution run has been done,
and we have wrfout_d01.date files.
We only need to run metgrid for the initial forecast time.
We have two options, either we force the user to do all the renaming themselves,
or we allow them to utilise the original namelist.input file, and add effectivley
add a column onto that. This could be done via a bunch of smaller utility steps.
e.g. shift_namelist namelist.input 3 > namelist.input
Which would rotate the columns of a namelist.input file so that the n-th column
becomes the first column.
Therefore we have to run ungrib, geogrid, metgrid
Assume the geo_em files exist for both domains.
What """
logger = shared.get_logger()
logger.info('*** PREPARING NDOWN ***')
namelist_wps = config['namelist_wps']
namelist_input = config['namelist_input']
max_dom = config['max_dom']
wrf_run_dir = config['wrf_run_dir']
if max_dom != 2:
raise ConfigError("max_dom must equal 2 when doing ndown runs")
bdy_times = shared.get_bdy_times(config)
ndown_fmt = config['ndown_fmt']
wrfout_d01_files = [
shared.sub_date(ndown_fmt, init_time=bdy_times[0], valid_time=t)
for t in bdy_times
]
for f in wrfout_d01_files:
if not os.path.exists(f):
raise MissingFile("File: %s missing" % f)
cmd = 'ln -sf %s %s' % (f, wrf_run_dir)
shared.run_cmd(cmd, config)
# Check for wrfinput_d02
wrfinput_d02 = '%s/wrfinput_d02' % wrf_run_dir
if not os.path.exists(wrfinput_d02):
raise MissingFile("wrfinput_d02 is missing")
os.rename('%s/wrfinput_d02' % wrf_run_dir, '%s/wrfndi_d02' % wrf_run_dir)
namelist = read_namelist(namelist_input)
# History interval is in minutes
history_interval = namelist.settings['history_interval']
interval_seconds = history_interval[0] * 60
namelist.update('interval_seconds', interval_seconds)
namelist.insert('io_form_auxinput2', 2, 'time_control')
namelist.to_file(namelist_input)
logger.info('*** DONE PREPARE NDOWN ***')
def update_namelist_wps(config):
""" Updates the namelist.wps to reflect updated settings in config
Arguments:
config -- dictionary containing various configuration options
"""
logger = shared.get_logger()
logger.debug('*** UPDATING namelist.wps ***')
#domain_dir = config['domain_dir']
#model_run = config['model_run']
#wps_dir = config['wps_dir']
wps_run_dir = config['wps_run_dir'] # required for opt_geogrid_tbl_path
#bdy_conditions = config['bdy_conditions']
namelist_wps = config['namelist_wps']
shutil.copyfile(namelist_wps, namelist_wps + '.backup')
bdy_times = shared.get_bdy_times(config)
max_dom = config['max_dom']
init_time = config['init_time']
met_em_dir = shared.sub_date(config['met_em_dir'], init_time=init_time)
geo_em_dir = config['geo_em_dir']
bdy_interval = config['bdy_interval']
interval_seconds = bdy_interval * 60 * 60
logger.debug('reading namelist.wps <--------- %s' % namelist_wps)
namelist = shared.read_namelist(namelist_wps)
#
# Update some options based on the forecast config file
#
namelist.update('max_dom', max_dom)
namelist.update('opt_output_from_geogrid_path',
geo_em_dir,
section='share')
namelist.update('opt_geogrid_tbl_path', wps_run_dir, section='geogrid')
namelist.update('opt_metgrid_tbl_path', wps_run_dir, section='metgrid')
namelist.update('interval_seconds', [interval_seconds])
#
# Generate formatted strings for inclusion in the namelist.wps file
#
start_str = bdy_times[0].strftime("%Y-%m-%d_%H:%M:%S")
end_str = bdy_times[-1].strftime("%Y-%m-%d_%H:%M:%S")
logger.debug("Updating namelist.wps start and end")
logger.debug(start_str)
logger.debug(end_str)
namelist.update('start_date', [start_str] * max_dom)
namelist.update('end_date', [end_str] * max_dom)
logger.debug('writing modified namelist.wps to file')
namelist.to_file(namelist_wps)
logger.debug('*** FINISHED UPDATING namelist.wps ***')
def update_namelist_wps(config):
""" Updates the namelist.wps to reflect updated settings in config
Arguments:
config -- dictionary containing various configuration options
"""
logger = shared.get_logger()
logger.debug('*** UPDATING namelist.wps ***')
#domain_dir = config['domain_dir']
#model_run = config['model_run']
#wps_dir = config['wps_dir']
wps_run_dir= config['wps_run_dir'] # required for opt_geogrid_tbl_path
#bdy_conditions = config['bdy_conditions']
namelist_wps = config['namelist_wps']
shutil.copyfile(namelist_wps, namelist_wps+'.backup')
bdy_times = shared.get_bdy_times(config)
max_dom = config['max_dom']
init_time = config['init_time']
met_em_dir = shared.sub_date(config['met_em_dir'], init_time=init_time)
geo_em_dir = config['geo_em_dir']
bdy_interval = config['bdy_interval']
interval_seconds = bdy_interval * 60 * 60
logger.debug('reading namelist.wps <--------- %s' % namelist_wps)
namelist = shared.read_namelist(namelist_wps)
#
# Update some options based on the forecast config file
#
namelist.update('max_dom', max_dom)
namelist.update('opt_output_from_geogrid_path', geo_em_dir, section='share')
namelist.update('opt_geogrid_tbl_path', wps_run_dir, section='geogrid')
namelist.update('opt_metgrid_tbl_path', wps_run_dir, section='metgrid')
namelist.update('interval_seconds', [interval_seconds])
#
# Generate formatted strings for inclusion in the namelist.wps file
#
start_str = bdy_times[0].strftime("%Y-%m-%d_%H:%M:%S")
end_str = bdy_times[-1].strftime("%Y-%m-%d_%H:%M:%S")
logger.debug("Updating namelist.wps start and end")
logger.debug(start_str)
logger.debug(end_str)
namelist.update('start_date', [start_str]*max_dom)
namelist.update('end_date', [end_str]*max_dom)
logger.debug('writing modified namelist.wps to file')
namelist.to_file(namelist_wps)
logger.debug('*** FINISHED UPDATING namelist.wps ***')
def prepare_wrf(config):
"""Checks that met_em files exist, and links into WRF/run directory.
Arguments:
config -- a dictionary containing forecast options
"""
logger = shared.get_logger()
logger.debug('*** PREPARING FILES FOR WRF ***')
met_em_format = "%Y-%m-%d_%H:%M:%S"
max_dom = config['max_dom']
domains = range(1, max_dom + 1)
init_time = config['init_time']
fcst_hours = config['fcst_hours']
bdy_interval = config['bdy_interval']
bdy_times = shared.get_bdy_times(config)
met_em_dir = shared.sub_date(config['met_em_dir'], init_time=init_time)
met_em_files = [
'%s/met_em.d%02d.%s.nc' % (met_em_dir, d, t.strftime(met_em_format))
for d in domains for t in bdy_times
]
wrf_run_dir = config['wrf_run_dir']
namelist_run = '%s/namelist.input' % wrf_run_dir
namelist_input = config['namelist_input']
logger.debug('linking met_em files:')
#
# Link met_em files. There are two options for error handling here.
# The first is to abort if any of the met_em files are missing.
# The second is just to run wrf and see how far it gets before
# running out of files. This will allow a partial forecast to run,
# even if later files are missing.
#
# To use the first approach, raise an exception when a missing
# file is encountered, otherwise just print a warning message.
#
# Actually, the two are equivalent so long as the met_em files
# are sorted.
#
for f in met_em_files:
if not os.path.exists(f):
raise IOError('met_em file missing : %s' % f)
cmd = 'ln -sf %s %s/' % (f, wrf_run_dir)
shared.run_cmd(cmd, config)
logger.debug('linking namelist.input to wrf_run_dir')
cmd = 'rm -f %s' % namelist_run
shared.run_cmd(cmd, config)
cmd = 'ln -sf %s %s' % (namelist_input, namelist_run)
shared.run_cmd(cmd, config)
logger.debug('*** FINISHED PREPARING FILES FOR WRF ***')
def prepare_wrf(config):
"""Checks that met_em files exist, and links into WRF/run directory.
Arguments:
config -- a dictionary containing forecast options
"""
logger =shared.get_logger()
logger.debug('*** PREPARING FILES FOR WRF ***')
met_em_format = "%Y-%m-%d_%H:%M:%S"
max_dom = config['max_dom']
domains = range(1,max_dom+1)
init_time = config['init_time']
fcst_hours = config['fcst_hours']
bdy_interval = config['bdy_interval']
bdy_times = shared.get_bdy_times(config)
met_em_dir = shared.sub_date(config['met_em_dir'], init_time=init_time)
met_em_files = ['%s/met_em.d%02d.%s.nc' % (met_em_dir,d, t.strftime(met_em_format)) for d in domains for t in bdy_times]
wrf_run_dir = config['wrf_run_dir']
namelist_run = '%s/namelist.input' % wrf_run_dir
namelist_input = config['namelist_input']
logger.debug('linking met_em files:')
#
# Link met_em files. There are two options for error handling here.
# The first is to abort if any of the met_em files are missing.
# The second is just to run wrf and see how far it gets before
# running out of files. This will allow a partial forecast to run,
# even if later files are missing.
#
# To use the first approach, raise an exception when a missing
# file is encountered, otherwise just print a warning message.
#
# Actually, the two are equivalent so long as the met_em files
# are sorted.
#
for f in met_em_files:
if not os.path.exists(f):
raise IOError('met_em file missing : %s' %f)
cmd = 'ln -sf %s %s/'%(f, wrf_run_dir)
shared.run_cmd(cmd, config)
logger.debug('linking namelist.input to wrf_run_dir')
cmd = 'rm -f %s' % namelist_run
shared.run_cmd(cmd, config)
cmd = 'ln -sf %s %s' %(namelist_input, namelist_run)
shared.run_cmd(cmd, config)
logger.debug('*** FINISHED PREPARING FILES FOR WRF ***')
def prepare_wps(config):
""" Runs all the pre-processing steps necessary for running WPS.
Reads the current value of init_time from config, and links
boundary condition files into correct directory. Creates an output
directory for the met_em files.
Arguments:
config -- dictionary containing various configuration options"""
logger = shared.get_logger()
logger.debug('*** PREPARING FILES FOR WPS ***')
wps_dir = config['wps_dir'] # the base installation of WPS
wps_run_dir = config['wps_run_dir'] # the directory to run WPS from
working_dir = config['working_dir'] # model run directory
met_em_dir = config['met_em_dir']
init_time = config['init_time']
grb_input_fmt = config['grb_input_fmt']
vtable = config['vtable']
bdy_times = shared.get_bdy_times(config)
if type(grb_input_fmt) == type({}):
logger.debug(grb_input_fmt)
fmts = grb_input_fmt.values()
else:
fmts = [grb_input_fmt]
for fmt in fmts:
#
# Generate filelist based on the initial time, and the forecast hour
#
filelist = shared.get_bdy_filenames(fmt, bdy_times)
#
# Check the boundary files exist
#
logger.debug('checking boundary condition files exists')
for f in filelist:
if not os.path.exists(f):
raise IOError('cannot find file: %s' % f)
logger.debug('all boundary conditions files exist')
#
# Run the link_grib scipt to link the FNL files
#
logger.debug(
'running link_grib.csh script to link grib files to GRIBFILE.AAA etc')
os.chdir(wps_run_dir)
args = ' '.join(filelist)
cmd = '%s/link_grib.csh %s' % (wps_run_dir, args)
shared.run(cmd, config)
logger.debug('Path for met_em files is %s' % met_em_dir)
if not os.path.exists(met_em_dir):
os.makedirs(met_em_dir)
logger.debug('*** FINISHED PREPARING FILES FOR WPS ***')
def run_ungrib(config):
""" Runs ungrib.exe and checks output was sucessfull
If vtable and gbr_input_fmt are NOT dictionaries,
then dictionarius will be constructed from them using
the key bdy_conditions from the metadata
Arguments:
config -- dictionary specifying configuration options
"""
logger = shared.get_logger()
wps_dir = config['wps_dir']
wps_run_dir = config['wps_run_dir']
namelist_wps = config['namelist_wps']
working_dir = config['working_dir']
met_em_dir = config['met_em_dir']
init_time = config['init_time']
log_file = '%s/ungrib.log' % wps_run_dir
vtable = config['vtable']
grb_input_fmt = config['grb_input_fmt']
grb_input_delay = config.get(
"grb_input_delay") # this allows None to be returned
bdy_conditions = config['bdy_conditions']
logger.info("\n*** RUNNING UNGRIB ***")
namelist = shared.read_namelist(namelist_wps)
bdy_times = shared.get_bdy_times(config)
if type(grb_input_fmt) != type({}):
grb_input_fmt = {bdy_conditions: grb_input_fmt}
if type(vtable) != type({}):
vtable = {bdy_conditions: vtable}
#
# Check that boundary conditions exist
#
for key in vtable.keys():
if grb_input_delay and key in grb_input_delay:
logger.debug("applying delay")
delay = datetime.timedelta(0, grb_input_delay[key] * 60 * 60)
new_bdy_times = [b - delay for b in bdy_times]
else:
logger.debug("no delay applied")
new_bdy_times = bdy_times
fmt = grb_input_fmt[key]
#
# Generate filelist based on the initial time, and the forecast hour
#
filelist = list(
OrderedDict.fromkeys(shared.get_bdy_filenames(fmt, new_bdy_times)))
#
# Check the boundary files exist
#
logger.debug('checking boundary condition files exists')
for f in filelist:
if not os.path.exists(f):
raise IOError('cannot find file: %s' % f)
logger.debug('all boundary conditions files exist')
#
# Now process boundary conditions
#
for key in vtable.keys():
if grb_input_delay and key in grb_input_delay:
logger.debug("applying delay")
delay = datetime.timedelta(0, grb_input_delay[key] * 60 * 60)
new_bdy_times = [b - delay for b in bdy_times]
else:
logger.debug("no delay applied")
new_bdy_times = bdy_times
fmt = grb_input_fmt[key]
#
# Generate filelist based on the initial time, and the forecast hour
#
filelist = list(
OrderedDict.fromkeys(shared.get_bdy_filenames(fmt, new_bdy_times)))
logger.debug(
'running link_grib.csh script to link grib files to GRIBFILE.AAA etc'
)
os.chdir(wps_run_dir)
args = ' '.join(filelist)
cmd = '%s/link_grib.csh %s' % (wps_run_dir, args)
shared.run_cmd(cmd, config)
vtab_path = vtable[key]
prefix = key
namelist.update('prefix', key)
namelist.to_file(namelist_wps)
link_namelist_wps(config)
vtab_wps = wps_run_dir + '/Vtable'
if os.path.exists(vtab_wps):
os.remove(vtab_wps)
cmd = 'ln -sf %s %s' % (vtab_path, vtab_wps)
logger.debug(cmd)
subprocess.call(cmd, shell=True)
#logger.debug("changing directory to %s" % wps_run_dir)
#os.chdir(wps_run_dir)
cmd = '%s/ungrib.exe' % wps_run_dir
logger.debug(cmd)
shared.run(cmd, config, wps_run_dir)
cmd = 'grep "Successful completion" %s/ungrib.log*' % wps_run_dir # check for success
ret = shared.run_cmd(cmd, config)
if ret != 0:
raise IOError('ungrib.exe did not complete')
logger.info('*** SUCESS UNGRIB ***\n')
def prepare_wps(config):
""" Runs all the pre-processing steps necessary for running WPS.
Reads the current value of init_time from config, and links
boundary condition files into correct directory. Creates an output
directory for the met_em files.
Arguments:
config -- dictionary containing various configuration options"""
logger = shared.get_logger()
logger.debug('*** PREPARING FILES FOR WPS ***')
wps_dir = config['wps_dir'] # the base installation of WPS
wps_run_dir = config['wps_run_dir'] # the directory to run WPS from
working_dir = config['working_dir'] # model run directory
met_em_dir = config['met_em_dir']
init_time = config['init_time']
grb_input_fmt = config['grb_input_fmt']
vtable = config['vtable']
bdy_times = shared.get_bdy_times(config)
if type(grb_input_fmt)==type({}):
logger.debug(grb_input_fmt)
fmts = grb_input_fmt.values()
else:
fmts = [grb_input_fmt]
for fmt in fmts:
#
# Generate filelist based on the initial time, and the forecast hour
#
filelist = shared.get_bdy_filenames(fmt, bdy_times)
#
# Check the boundary files exist
#
logger.debug('checking boundary condition files exists')
for f in filelist:
if not os.path.exists(f):
raise IOError('cannot find file: %s' %f)
logger.debug('all boundary conditions files exist')
#
# Run the link_grib scipt to link the FNL files
#
logger.debug('running link_grib.csh script to link grib files to GRIBFILE.AAA etc')
os.chdir(wps_run_dir)
args = ' '.join(filelist)
cmd = '%s/link_grib.csh %s' %(wps_run_dir,args)
shared.run(cmd, config)
logger.debug('Path for met_em files is %s' % met_em_dir)
if not os.path.exists(met_em_dir):
os.makedirs(met_em_dir)
logger.debug('*** FINISHED PREPARING FILES FOR WPS ***')
def run_ungrib(config):
""" Runs ungrib.exe and checks output was sucessfull
If vtable and gbr_input_fmt are NOT dictionaries,
then dictionarius will be constructed from them using
the key bdy_conditions from the metadata
Arguments:
config -- dictionary specifying configuration options
"""
logger =shared.get_logger()
wps_dir = config['wps_dir']
wps_run_dir = config['wps_run_dir']
namelist_wps = config['namelist_wps']
working_dir = config['working_dir']
met_em_dir = config['met_em_dir']
init_time = config['init_time']
log_file = '%s/ungrib.log' % wps_run_dir
vtable = config['vtable']
grb_input_fmt = config['grb_input_fmt']
grb_input_delay = config.get("grb_input_delay") # this allows None to be returned
bdy_conditions = config['bdy_conditions']
logger.info("\n*** RUNNING UNGRIB ***")
namelist = shared.read_namelist(namelist_wps)
bdy_times = shared.get_bdy_times(config)
if type(grb_input_fmt)!=type({}):
grb_input_fmt = {bdy_conditions:grb_input_fmt}
if type(vtable)!=type({}):
vtable = {bdy_conditions:vtable}
#
# Check that boundary conditions exist
#
for key in vtable.keys():
if grb_input_delay and key in grb_input_delay:
logger.debug("applying delay")
delay = datetime.timedelta(0, grb_input_delay[key]*60*60)
new_bdy_times = [b - delay for b in bdy_times]
else:
logger.debug("no delay applied")
new_bdy_times = bdy_times
fmt = grb_input_fmt[key]
#
# Generate filelist based on the initial time, and the forecast hour
#
filelist = list(OrderedDict.fromkeys(shared.get_bdy_filenames(fmt, new_bdy_times)))
#
# Check the boundary files exist
#
logger.debug('checking boundary condition files exists')
for f in filelist:
if not os.path.exists(f):
raise IOError('cannot find file: %s' %f)
logger.debug('all boundary conditions files exist')
#
# Now process boundary conditions
#
for key in vtable.keys():
if grb_input_delay and key in grb_input_delay:
logger.debug("applying delay")
delay = datetime.timedelta(0, grb_input_delay[key]*60*60)
new_bdy_times = [b - delay for b in bdy_times]
else:
logger.debug("no delay applied")
new_bdy_times = bdy_times
fmt = grb_input_fmt[key]
#
# Generate filelist based on the initial time, and the forecast hour
#
filelist = list(OrderedDict.fromkeys(shared.get_bdy_filenames(fmt, new_bdy_times)))
logger.debug('running link_grib.csh script to link grib files to GRIBFILE.AAA etc')
os.chdir(wps_run_dir)
args = ' '.join(filelist)
cmd = '%s/link_grib.csh %s' %(wps_run_dir,args)
shared.run_cmd(cmd, config)
vtab_path = vtable[key]
prefix = key
namelist.update('prefix', key)
namelist.to_file(namelist_wps)
link_namelist_wps(config)
vtab_wps = wps_run_dir+'/Vtable'
if os.path.exists(vtab_wps):
os.remove(vtab_wps)
cmd = 'ln -sf %s %s' %(vtab_path, vtab_wps)
logger.debug(cmd)
subprocess.call(cmd, shell=True)
#logger.debug("changing directory to %s" % wps_run_dir)
#os.chdir(wps_run_dir)
cmd = '%s/ungrib.exe' % wps_run_dir
logger.debug(cmd)
shared.run(cmd, config, wps_run_dir)
cmd = 'grep "Successful completion" %s/ungrib.log*' % wps_run_dir # check for success
ret =shared.run_cmd(cmd,config)
if ret!=0:
raise IOError('ungrib.exe did not complete')
logger.info('*** SUCESS UNGRIB ***\n')
