hwrf.hwrfsystem.HWRFGSIPostProcessing Class Reference

Configures the GSI post-processing and regribbing. More...

Detailed Description

Configures the GSI post-processing and regribbing.

Constructs tasks that will run the post-processing and regribbing on the inputs and outputs of GSI. Arranges for the standard HWRF GSI diagnostic output grids, and makes them configurable by the HWRF config files.

This class uses a config section to define many aspects of the GSI post-processing.

[gsi_products]
# Settings for GRIB1 grid 255 for each grid:
d3_grid=0.02,0.02,12.,12.,136,600,600
d2_grid=0.06,0.06,30.,30.,136,500,500

# GRIB2 compression method
grib2_compression=32  ; complex packing with second-order differences
# grib2_compression=40   ; "lossless" jpeg 2000

# Delivery settings:
hwrforg_n%com={out_prefix}.hwrforg_n.grb2f00
hwrforg_i%com={out_prefix}.hwrforg_i.grb2f00
hwrfges_n%com={out_prefix}.hwrfges_n.grb2f00
hwrfges_i%com={out_prefix}.hwrfges_i.grb2f00
hwrfanl_n%com={out_prefix}.hwrfanl_n.grb2f00
hwrfanl_i%com={out_prefix}.hwrfanl_i.grb2f00

The d2_grid and d3_grid options configure the intermediate and innermost domain output grids. They are sent into add_clatlon_grid() to generate the GRIB1 grid 255 (user-defined regular latitude-longitude) grid definition for interpolation.

Definition at line 121 of file hwrfsystem.py.

Inheritance diagram for hwrf.hwrfsystem.HWRFGSIPostProcessing:

Public Member Functions
def	__init__ (self, ds, conf, section, kwargs)
	HWRFGSIPostProcessing constructor. More...
def	make_gsi_post
	Creates the gsi post-processor and regribber tasks. More...
Public Member Functions inherited from hwrf.hwrftask.HWRFTask
def	__init__ (self, dstore, conf, section, taskname=None, workdir=None, outdir=None, storminfo=UNSPECIFIED, taskvars=UNSPECIFIED, kwargs)
	Creates an HWRFTask. More...
def	isfakestorm (self)
def	ismultistorm (self)
def	get_workdir (self)
	Returns the directory the class should work in, as set by the "workdir" metadata value. More...
def	set_workdir (self, val)
	Sets the directory the class should work in. More...
def	get_outdir (self)
	Gets the directory that should receive output data. More...
def	set_outdir (self, val)
	Sets the directory that should receive output data. More...
def	realtime (self)
	Is this job a real-time forecast job? More...
def	redirect (self)
	Should subprograms' outputs be redirected to separate files?
def	scrub (self)
	Should temporary files be deleted as soon as they are not needed?
def	tvset (self, opt, val)
	Sets a taskvar option's value. More...
def	tvdel (self, opt)
	Deletes an object-local value set by tvset. More...
def	tvget (self, opt)
	Gets a taskvar's value. More...
def	tvhave
	Is a taskvar set? More...
def	taskvars (self)
	The dict of object-local values used for string substitution. More...
def	confint
	Alias for self.conf.getint for section self.section. More...
def	confstr
	Alias for self.conf.getstr for section self.section. More...
def	conffloat
	Alias for self.conf.getfloat for section self.section. More...
def	confbool
	Alias for self.conf.getbool for section self.section. More...
def	confget
	Alias for self.conf.get for section self.section. More...
def	confitems
	Alias for self.conf.items for section self.section. More...
def	confstrinterp (self, string, section=None, kwargs)
	Alias for self.icstr for backward compatibility. More...
def	conftimestrinterp (self, string, ftime, atime=None, section=None, kwargs)
	Alias for self.timestr for backward comaptibility. More...
def	confraw
	Get a raw configuration value before string expansion. More...
def	icstr (self, string, section=None, kwargs)
	Expands a string in the given conf section. More...
def	timestr (self, string, ftime, atime=None, section=None, kwargs)
	Expands a string in the given conf section, including time vars. More...
def	getdir
	Alias for hwrf.config.HWRFConfig.get() for the "dir" section. More...
def	getexe
	Alias for hwrf.config.HWRFConfig.get() for the "exe" section. More...
def	getconf (self)
	Returns this HWRFTask's hwrf.config.HWRFConfig object. More...
def	getsection (self)
	Returns this HWRFTask's section name in the HWRFConfig. More...
def	log
	Obtain a logging domain. More...
def	inputiter (self)
	Iterates over all inputs required by this task. More...
Public Member Functions inherited from produtil.datastore.Task
def	__init__ (self, dstore, taskname, logger=None, kwargs)
	Task constructor. More...
def	jlogfile (self)
	returns the jlogfile logger. More...
def	postmsg (self, message, args, kwargs)
	same as produtil.log.jlogger.info() More...
def	setstate (self, val)
	Sets the state of this job. More...
def	getstate (self)
	Returns the job state. More...
def	strstate (self)
	A string representation of the job state. More...
def	gettaskname (self)
	Returns the task name part of the database ID, which is the same as the prodname. More...
def	products (self, args, kwargs)
	Iterate over the products this task produces. More...
def	log (self)
	Returns the logger object for this task. More...
def	clean (self)
	Cleans up any unneeded data used by this task. More...
def	unrun (self)
	Undoes the effect of run(). More...
def	run (self)
	Performs the work this Task should do and generates all products. More...
def	is_completed (self)
	Is this task complete? More...
def	completed (self)
	Read-only property: is this task completed? Same as is_completed() More...
def	runpart (self)
	Run some of this task's work, deliver some products. More...
Public Member Functions inherited from produtil.datastore.Datum
def	__init__ (self, dstore, prodname, category, meta=None, cache=30, location=None, kwargs)
	Datum constructor. More...
def	__enter__ (self)
	Acquires this object's thread lock. More...
def	__exit__ (self, etype, evalue, traceback)
	Releases this object's thread lock. More...
def	validate (self)
	Validates this object's Datastore, prodname and category. More...
def	getid (self)
	Returns the database ID of this datum. More...
def	getdatastore (self)
	Returns the datastore of this datum. More...
def	transaction (self)
	Creates, but does not lock, a Transaction for this datum's datastore. More...
def	getprodtype (self)
	Returns the product type of this Datum. More...
def	getprodname (self)
	Returns the product name part of the database ID. More...
def	getcategory (self)
	Returns the product category part of the database ID. More...
def	getlocation (self)
	Returns the "location" field of this Datum's database entry. More...
def	setlocation (self, v)
	Sets the "location" field of this Datum's database entry. More...
def	__hash__ (self)
	Integer hash function. More...
def	__str__ (self)
	Human-readable description of this Datum. More...
def	__repr__ (self)
	Python code-like description of this Datum. More...
def	__cmp__ (self, other)
	Compares two Datums' prodnames and categories. More...
def	set_loc_avail (self, loc, avail)
	Sets the location and availability of this Datum in a single transaction. More...
def	update (self)
	Discards all cached metadata and refreshes it from the Datastore. More...
def	__getitem__ (self, k)
	Returns the value of the specified metadata key or raises KeyError. More...
def	meta
	Return the value of a metadata key. More...
def	get
	Alias for self.meta() Returns the value of the specified metadata key or returns default if it is unset. More...
def	__setitem__ (self, k, v)
	Sets the value of the specified metadata key. More...
def	__delitem__ (self, k)
	Deletes the specified metadata key, which must not be "available" or "location". More...
def	__contains__ (self, k)
	Determines if a metadata key is set. More...
def	iteritems (self)
	Iterates over all metadata (key,value) pairs for this Datum, including "available" and "location". More...

Public Attributes
	gsipost
	The hwrf.gsipost.GSIPost object that will post-process GSI inputs and outputs, creating native E grid GRIB files. More...
	gsigribber
	The hwrf.gribtask.GRIBTask that will regrid the output of the gsipost, creating lat-lon grib files as defined in the configuration files. More...
Public Attributes inherited from hwrf.hwrftask.HWRFTask
	storminfo
	The hwrf.storminfo.StormInfo describing the vitals information for the storm processed by this HWRFTask. More...

Additional Inherited Members
Properties inherited from hwrf.hwrftask.HWRFTask
	workdir
	The directory in which this task should be run. More...
	outdir
	The directory in which this task should deliver its final output. More...
	conf
	This HWRFTask's hwrf.config.HWRFConfig object. More...
	section
	The confsection in self.section for this HWRFTask (read-only) More...
Properties inherited from produtil.datastore.Task
	state
	Read-write property: the job state. More...
	taskname
	Read-only property: the name of this task. More...
Properties inherited from produtil.datastore.Datum
	prodname = property(getprodname,None,None,)
	Read-only property, an alias for getprodname(): the product name part of the database ID. More...
	category = property(getcategory,None,None,)
	Read-only property, an alias for getcategory(), the category name part of the database ID. More...
	prodtype
	Read-only property, an alias for getprodtype(), the product type. More...
	did
	Read-only property, an alias for getid(). More...
	dstore
	Read-only property, an alias for getdatastore(), the Datastore in which this Datum resides. More...
	location
	Read-write property, an alias for getlocation() and setlocation(). More...

Constructor & Destructor Documentation

def hwrf.hwrfsystem.HWRFGSIPostProcessing.__init__	(		self,
			ds,
			conf,
			section,
			kwargs
	)

HWRFGSIPostProcessing constructor.

Parameters

ds	passed to Datum: the Datastore object for this Task
conf	the conf object for this task (passed to HWRFTask)
section	the conf section for this task (passed to HWRFTask)
kwargs	more keyword arguments passed to superclass

Definition at line 155 of file hwrfsystem.py.

Member Function Documentation

def hwrf.hwrfsystem.HWRFGSIPostProcessing.make_gsi_post	(		self,
			gsi_d02,
			gsi_d03,
			storm1ghost,
			storm1ghost_parent,
			ceninit,
			gsid03_flag,
			gsipost_name = 'gsipost',
			gsigribber_name = 'gsigribber'
	)

Creates the gsi post-processor and regribber tasks.

Creates the gsipost member variable, an hwrf.gsipost.GSIPost; and the gsigribber member variable, an hwrf.gribtask.GRIBTask. The gsipost converts GSI input and output files (wrfinput, ghost or wrfanl) to native E grid GRIB1 files. The gsigribber converts the E grid GRIB1 files to GRIB2 files on selected output grids.

Parameters

gsi_d02	the hwrf.gsi.FGATGSI that runs the intermediate domain data assimilation
gsi_d03	the hwrf.gsi.FGATGSI that runs the innermost domain data assimilation
storm1ghost	the hwrf.wrf.WRFDomain that represents the innermost ghost domain
storm1ghost_parent	the hwrf.wrf.WRFDomain that represents the intermediate ghost domain
ceninit	the hwrf.init.InitBeforeGSI that runs the analysis time (FGAT 0 hour) initialization off of the GDAS 6hr forecast.
gsid03_flag	True=domain 3 gsi was run, False otherwise
gsipost_name	the section and task name for the gsipost
gsigribber_name	the section and task name for the gsigribber

Definition at line 165 of file hwrfsystem.py.

Referenced by hwrf.hwrfsystem.HWRFGSIPostProcessing.__init__().

Member Data Documentation

hwrf.hwrfsystem.HWRFGSIPostProcessing.gsigribber

The hwrf.gribtask.GRIBTask that will regrid the output of the gsipost, creating lat-lon grib files as defined in the configuration files.

Definition at line 246 of file hwrfsystem.py.

hwrf.hwrfsystem.HWRFGSIPostProcessing.gsipost

The hwrf.gsipost.GSIPost object that will post-process GSI inputs and outputs, creating native E grid GRIB files.

Definition at line 245 of file hwrfsystem.py.

---

The documentation for this class was generated from the following file:

• /mnt/pan2/projects/hwrfv3/Samuel.Trahan/trunk/ush/hwrf/hwrfsystem.py