hwrf.gsi Namespace Reference

Runs the GSI data assimilation on the HWRF system. More...

Detailed Description

Runs the GSI data assimilation on the HWRF system.

Classes
class	FGATGSI
	Runs the GSI based on the HWRF FGAT scheme. More...
class	GSIBase
	Base class of anything that runs the GSI. More...

Functions
def	unset_gsistatus
	Delete the gsi status file. More...
def	set_gsistatus
	Sets the GSI status files. More...
def	get_gsistatus
	Checks the gsi status for a specific domain. More...

Variables
list	__all__ = ['GSI_DATA_TYPES', 'GSIBase', 'FGATGSI' ]
	The list of symbols exported by "from hwrf.gsi import *".
list	GSI_DATA_TYPES
	List of all known GSI datastypes. More...

Function Documentation

def hwrf.gsi.get_gsistatus	(		conf,
			domain,
			logger = None
	)

Checks the gsi status for a specific domain.

Checks the first GSI status file, scanning for information about the specified domain. If the file does not exist or cannot be opened or read, then False is returned. Otherwise, the file is scanned for run_gsi_d02=YES/NO or run_gsi_d03=YES/NO (case insensitive). The last of those run_gsi_d02/d03 lines is used: NO=return False, YES=return True.

Parameters

conf	the hwrf.config.HWRFConfig object with configuration info
domain	either "gsi_d02" or "gsi_d03", the domain of interest
logger	Optional: the logging.Logger for log messages

Definition at line 1273 of file gsi.py.

Referenced by scripts.exhwrf_check_init.check_gsi(), scripts.exhwrf_merge.main(), and scripts.exhwrf_gsi.main().

def hwrf.gsi.set_gsistatus	(		conf,
			logger = None
	)

Sets the GSI status files.

Set run_gsi_d02=YES (true) or =NO (false) depending on the configuration. If the logger is not specified, the gsistatus subdomain of the conf default logging domain is used.

Parameters

conf	the hwrf.config.HWRFConfig object
logger	Optional: the logging.Logger for log messages.

Definition at line 1233 of file gsi.py.

def hwrf.gsi.unset_gsistatus	(		conf,
			logger = None
	)

Delete the gsi status file.

Deletes all GSI status files, whose paths are determined from the given config object. If the logger is not specified, the gsistatus subdomain of the conf default logging domain is used.

Parameters

conf	the hwrf.config.HWRFConfig object
logger	Optional: a logging.Logger for logging.

Definition at line 1219 of file gsi.py.

Variable Documentation

hwrf.gsi.GSI_DATA_TYPES

Initial value:

= [
    "hirs2_n14", "msu_n14", "sndr_g08", "sndr_g11", "sndr_g12", "sndr_g13",
    "sndr_g08_prep", "sndr_g11_prep", "sndr_g12_prep", "sndr_g13_prep",
    "sndrd1_g11", "sndrd2_g11", "sndrd3_g11", "sndrd4_g11", "sndrd1_g12", 
    "sndrd2_g12", "sndrd3_g12", "sndrd4_g12", "sndrd1_g13", "sndrd2_g13",
    "sndrd3_g13", "sndrd4_g13", "sndrd1_g14", "sndrd2_g14", "sndrd3_g14",
    "sndrd4_g14", "sndrd1_g15", "sndrd2_g15", "sndrd3_g15", "sndrd4_g15",
    "hirs3_n15", "hirs3_n16", "hirs3_n17", "amsua_n15", "amsua_n16",
    "amsua_n17", "amsub_n15", "amsub_n16", "amsub_n17", "hsb_aqua",
    "airs_aqua", "amsua_aqua", "imgr_g08", "imgr_g11", "imgr_g12",
    "imgr_g14", "imgr_g15", "pcp_ssmi_dmsp", "pcp_tmi_trmm", "conv",
    "sbuv2_n16", "sbuv2_n17", "sbuv2_n18", "sbuv2_n19", "gome_metop-a",
    "omi_aura", "mls_aura", "ssmi_f13", "ssmi_f14", "ssmi_f15",
    "hirs4_n18", "hirs4_metop-a", "amsua_n18", "amsua_metop-a", "mhs_n18",
    "mhs_metop-a", "amsre_low_aqua", "amsre_mid_aqua", "amsre_hig_aqua",
    "ssmis_f16", "ssmis_f17", "ssmis_f18", "ssmis_f19", "ssmis_f20",
    "iasi_metop-a", "hirs4_n19", "amsua_n19", "mhs_n19", "seviri_m08",
    "seviri_m09", "seviri_m10", "cris_npp", "atms_npp", "hirs4_metop-b",
    "amsua_metop-b", "mhs_metop-b", "iasi_metop-b", "gome_metop-b" ]

List of all known GSI datastypes.

Definition at line 26 of file gsi.py.