hwrf.bufrprep.Bufrprep Class Reference

This is a HWRF task that preprocesses observations in data tanks to create bufr files suitable for input to hwrf.gsi classes. More...

Detailed Description

This is a HWRF task that preprocesses observations in data tanks to create bufr files suitable for input to hwrf.gsi classes.

It also does other preprocessing of bufr and prepbufr files.

Definition at line 21 of file bufrprep.py.

Inheritance diagram for hwrf.bufrprep.Bufrprep:

Public Member Functions
def	__init__ (self, dstore, conf, section, taskname=None, atime=None, kwargs)
	Bufrprep constructor. More...
def	getstormid (self)
	The storm ID. More...
def	grab_bufr
	Links or copies all needed bufr files to the local directory. More...
def	grab_obstype_section
	Copies or links observations specified in the obstype sections to the current working directory. More...
def	grab_prepbufr (self, atime=None, kwargs)
	Links or copies the prepbufr file to the local directory. More...
def	tdrdump
	Dump TDR data for operational run. More...
def	prep_prepbufr (self, option)
	pre-process prepbufr data More...
def	write_vitals
	Writes the tcvitals (from self.storminfo) to the specified file. More...
def	run (self)
	Runs and delivers the results. More...
def	readtdrstmid (self)
	Runs the hwrf_readtdrstmid program. More...
def	readtdrtime (self)
	Runs the hwrf_readtdrtime program. More...
def	set_tdrstatus (self)
	Create a TDR status file in com directory.
def	deliver_products (self, atime=None, kwargs)
	Delivers output products to the intercom directory. 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...

Additional Inherited Members
Public Attributes inherited from hwrf.hwrftask.HWRFTask
	storminfo
	The hwrf.storminfo.StormInfo describing the vitals information for the storm processed by this HWRFTask. More...
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.bufrprep.Bufrprep.__init__	(		self,
			dstore,
			conf,
			section,
			taskname = None,
			atime = None,
			kwargs
	)

Bufrprep constructor.

Parameters

dstore	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)
taskname	Optional: the taskname for this product in the datastore
atime	the analsysis time
kwargs	Additional keyword arguments are passed to the hwrf.hwrftask.HWRFTask.__init__ constructor

Definition at line 27 of file bufrprep.py.

Member Function Documentation

def hwrf.bufrprep.Bufrprep.deliver_products	(		self,
			atime = None,
			kwargs
	)

Delivers output products to the intercom directory.

Parameters

atime	the analysis time
kwargs	Sent to hwrf.input.DataCatalog.parse()

Definition at line 361 of file bufrprep.py.

Referenced by hwrf.mpipomtc.POMInit.run(), hwrf.ww3.WW3Init.run(), hwrf.finalmergetask.FinalMergeTask.run(), hwrf.bufrprep.Bufrprep.run(), hwrf.wps.Geogrid.run(), hwrf.gsi.GSIBase.run(), hwrf.wps.Ungrib.run(), hwrf.wps.Metgrid.run(), and hwrf.relocate.Merge.run().

def hwrf.bufrprep.Bufrprep.getstormid

(

self

)

The storm ID.

Definition at line 67 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run().

def hwrf.bufrprep.Bufrprep.grab_bufr	(		self,
			atime = None,
			morevars = None
	)

Links or copies all needed bufr files to the local directory.

Parameters

atime	the analysis time
morevars	passed to hwrf.config.HWRFConfig.get() and similar routines to define string replacements

Definition at line 87 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run(), and hwrf.gsi.GSIBase.run().

def hwrf.bufrprep.Bufrprep.grab_obstype_section	(		self,
			section,
			atime = None,
			morevars = None
	)

Copies or links observations specified in the obstype sections to the current working directory.

The section listed in self.section should contain an obstype option, whose value is a comma separated list of section names. This method reads every section in that list. For each section, the option keys are the local directory filenames expected by GSI, while the values are the data type part of the operational filename (ie.: the satwind in gfs.t12z.tm00.satwind.bufr_d). There are a few special keys:

• dataset - the name of the dataset for hwrf.input purposes
• item - the name of the item for hwrf.input purposes
• type - the type of observation: satellite, or anything else. At present, only "satellite" has any special meaning.

If the type is "satellite" then the entire section will be skipped if sat_da=False in this task's config section.

Once the section is parsed, the files are all linked to this directory.

Parameters

section	Name of the section to read.
atime	Analysis time.
morevars	A dict for additional string replacements in the hwrf.config.HWRFConfig.get() family of functions.

Definition at line 100 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.grab_bufr(), and hwrf.gsi.GSIBase.grab_bufr().

def hwrf.bufrprep.Bufrprep.grab_prepbufr	(		self,
			atime = None,
			kwargs
	)

Links or copies the prepbufr file to the local directory.

Parameters

atime	The analysis time.
kwargs	More string substitution variables for the hwrf.config.HWRFConfig family of functions.

Definition at line 175 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run(), and hwrf.gsi.GSIBase.run().

def hwrf.bufrprep.Bufrprep.prep_prepbufr	(		self,
			option
	)

pre-process prepbufr data

Options:

• option 0: make no change
• option 1: remove some inner-core data
• option 2: flag/unflag mass and dropsonde u, v data
• option 3: unflag HS3 dropsonde data

Definition at line 235 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run().

def hwrf.bufrprep.Bufrprep.readtdrstmid

(

self

)

Runs the hwrf_readtdrstmid program.

Definition at line 317 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run().

def hwrf.bufrprep.Bufrprep.readtdrtime

(

self

)

Runs the hwrf_readtdrtime program.

Definition at line 330 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run().

def hwrf.bufrprep.Bufrprep.run

(

self

)

Runs and delivers the results.

Definition at line 283 of file bufrprep.py.

Referenced by produtil.datastore.Task.runpart(), and hwrf.bufrprep.Bufrprep.tdrdump().

def hwrf.bufrprep.Bufrprep.tdrdump	(		self,
			atime = None,
			morevars = None
	)

Dump TDR data for operational run.

Parameters

atime	The analysis time.
morevars	More string substitution variables for the hwrf.config.HWRFConfig.get() family of functions.

Definition at line 200 of file bufrprep.py.

Referenced by hwrf.bufrprep.Bufrprep.run().

def hwrf.bufrprep.Bufrprep.write_vitals	(		self,
			filename = 'tcvitals',
			logger = None
	)

Writes the tcvitals (from self.storminfo) to the specified file.

Parameters

filename	Name of the file to write
logger	A logging.Logger for log messages

Definition at line 272 of file bufrprep.py.

Referenced by hwrf.relocate.RelocationTask.copy_inputs(), hwrf.bufrprep.Bufrprep.prep_prepbufr(), hwrf.relocate.Stage1.run(), hwrf.gsi.GSIBase.run(), and hwrf.relocate.Stage2.run().

---

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

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