hwrf.prelaunch Namespace Reference

Functions called automatically before a cycle is launched. More...

Detailed Description

Functions called automatically before a cycle is launched.

This module contains utility functions for the hwrf.launcher.launch() prelaunch argument. These functions edit the configuration of an individual cycle before the cycle starts.

Functions
def	prelaunch_ensid (conf, logger)
	Changes the ungrib item and item2 based on the ensemble ID. More...
def	prelaunch_ungrib (conf, logger, cycle)
	Change the ungrib table based on the year. More...
def	prelaunch_rsmc (conf, logger, cycle)
	Modifies the configuration for the RSMC (JTWC, NHC, etc.) More...
def	prelaunch_basin (conf, logger, cycle)
	Modifies the configuration for the basin. More...

Variables
list	__all__ = ['prelaunch_ungrib','prelaunch_rsmc','prelaunch_basin']
	Symbols exported by "from hwrf.prelaunch import *".

Function Documentation

def hwrf.prelaunch.prelaunch_basin	(		conf,
			logger,
			cycle
	)

Modifies the configuration for the basin.

Modifies the configuration to work differently for each basin. Searches for the basin_conf option in the [prelaunch] section for the name of a configuration file to read, and reads it if it exists. If it does not exist, searches for the no_basin_conf section in [prelaunch] and runs that instead, if it exists.

Parameters

conf	the hwrf.config.HWRFConfig to modify
logger	the logging.Logger for log messages
cycle	the cycle being run.

Definition at line 78 of file prelaunch.py.

Referenced by hwrf_expt.prelaunch().

def hwrf.prelaunch.prelaunch_ensid	(		conf,
			logger
	)

Changes the ungrib item and item2 based on the ensemble ID.

This is used to ensure ensemble member 0 uses the GEFS control, which has a different item in the hwrf.input.DataCatalog.

Definition at line 15 of file prelaunch.py.

Referenced by hwrf_expt.prelaunch().

def hwrf.prelaunch.prelaunch_rsmc	(		conf,
			logger,
			cycle
	)

Modifies the configuration for the RSMC (JTWC, NHC, etc.)

Modifies the configuration to work differently for JTWC and NHC storms. Searches for the rsmc_conf option in the [prelaunch] section for the name of a configuration file to read, and reads it if it exists.

Parameters

conf	the hwrf.config.HWRFConfig to modify
logger	the logging.Logger for log messages
cycle	the cycle being run.

Definition at line 55 of file prelaunch.py.

Referenced by hwrf_expt.prelaunch().

def hwrf.prelaunch.prelaunch_ungrib	(		conf,
			logger,
			cycle
	)

Change the ungrib table based on the year.

Modifies the tbl entry in the [ungrib] section based on the year if a tbl$YEAR is available for the year of the cycle being run.

Parameters

conf	the hwrf.config.HWRFConfig to modify
logger	the logging.Logger for log messages
cycle	the cycle being run.

Definition at line 33 of file prelaunch.py.

Referenced by hwrf_expt.prelaunch().