hwrf_wcoss Namespace Reference

This module contains various utility functions for running on WCOSS, the machine that the US National Weather Service uses for its operational forecasting. More...

Detailed Description

This module contains various utility functions for running on WCOSS, the machine that the US National Weather Service uses for its operational forecasting.

Functions
def	loudenv (logger, var, value)
	Set an environment variable and log a message about it. More...
def	fcst_wcoss1 (logger, coupled)
	Sets task geometry for Phase 1 WCOSS. More...
def	fcst_wcoss2 (logger, coupled)
	Sets task geometry for Phase 2 WCOSS. More...
def	set_vars_for_products (logger)
	Sets variables to speed up the products job on WCOSS. More...
def	set_vars_for_coupled_hwrf (logger, wave, ocean, wrf_ranks)
	Sets variables that seem to speed up the H15B (2015 pre-baseline) version of HWRF on Phase I WCOSS. More...
def	set_vars_for_ensda_hwrf (logger)
	Sets variables that seem to speed up the H15B (2015 pre-baseline) version of HWRF on Phase 2 WCOSS when running ensda jobs. More...
def	set_vars_for_gsi (logger)
	Set variables for running GSI quickly on WCOSS. More...

Variables
list	__all__
	Symbols to export by "from hwrf_wcoss import *". More...

Function Documentation

def hwrf_wcoss.fcst_wcoss1	(		logger,
			coupled
	)

Sets task geometry for Phase 1 WCOSS.

Parameters

logger	a logging.Logger for messages
coupled	if True, a coupled forecast, if False, uncoupled

Definition at line 21 of file hwrf_wcoss.py.

Referenced by set_vars_for_coupled_hwrf().

def hwrf_wcoss.fcst_wcoss2	(		logger,
			coupled
	)

Sets task geometry for Phase 2 WCOSS.

Parameters

logger	a logging.Logger for messages
coupled	if True, a coupled forecast, if False, uncoupled

Definition at line 34 of file hwrf_wcoss.py.

Referenced by set_vars_for_coupled_hwrf().

def hwrf_wcoss.loudenv	(		logger,
			var,
			value
	)

Set an environment variable and log a message about it.

Parameters

logger	a logging.Logger for the message
var	the variable to set in os.environ
value	the value of the variable

Definition at line 13 of file hwrf_wcoss.py.

Referenced by fcst_wcoss1(), fcst_wcoss2(), set_vars_for_coupled_hwrf(), set_vars_for_ensda_hwrf(), set_vars_for_gsi(), and set_vars_for_products().

def hwrf_wcoss.set_vars_for_coupled_hwrf	(		logger,
			wave,
			ocean,
			wrf_ranks
	)

Sets variables that seem to speed up the H15B (2015 pre-baseline) version of HWRF on Phase I WCOSS.

Parameters

logger	a logging.Logger for log messages
wave	"WW3" or the empty string
ocean	"POM", "HYCOM" or the empty string
wrf_ranks	Number of WRF ranks. If this number is small, then the function assumes a custom task count is in use, and will not set task geometry. This is a kludge used to prevent 2km task geometry settings for the 3km configuration.

Definition at line 60 of file hwrf_wcoss.py.

Referenced by scripts.exhwrf_forecast.set_vars().

def hwrf_wcoss.set_vars_for_ensda_hwrf

(

logger

)

Sets variables that seem to speed up the H15B (2015 pre-baseline) version of HWRF on Phase 2 WCOSS when running ensda jobs.

Parameters

logger

a logging.Logger for log messages

Definition at line 101 of file hwrf_wcoss.py.

Referenced by scripts.exhwrf_ensda.set_vars().

def hwrf_wcoss.set_vars_for_gsi

(

logger

)

Set variables for running GSI quickly on WCOSS.

This routine is copied verbatim from the old ksh-based hwrf_nmm_gsi_d*.sh scripts and modified line-by-line for Python. It speeds up the 2014 HWRF GSI jobs by more than a factor of three.

Parameters

logger

a logging.Logger for log messages

Definition at line 117 of file hwrf_wcoss.py.

Referenced by scripts.exhwrf_gsi.main().

def hwrf_wcoss.set_vars_for_products

(

logger

)

Sets variables to speed up the products job on WCOSS.

Parameters

logger

a logging.Logger for log messages

Definition at line 47 of file hwrf_wcoss.py.

Referenced by scripts.exhwrf_products.doit().

Variable Documentation

hwrf_wcoss.__all__

Initial value:

= ['set_vars_for_coupled_hwrf','set_vars_for_gsi',
         'set_vars_for_products']

Symbols to export by "from hwrf_wcoss import *".

Definition at line 10 of file hwrf_wcoss.py.