hwrf.fcsttask.FcstTask Class Reference

abstract base class of anything that runs or prepares input for a forecast model More...

Detailed Description

abstract base class of anything that runs or prepares input for a forecast model

Abstract base class of anything that runs a forecast model, or prepares input to a forecast model. This should not be instantiated directly. It exists just to simplify code in subclasses.

Definition at line 363 of file fcsttask.py.

Inheritance diagram for hwrf.fcsttask.FcstTask:

Public Member Functions
def	__init__ (self, dstore, conf, section, outdir=None, taskname=None, kwargs)
	Creates a FcstTask object. More...
def	has_input (self, typename)
	is there any input data of this type to this task? More...
def	add_input (self, typename, inobj)
	add input of a specified type More...
def	check_input (self, typenames, kwargs)
	check if input data is available More...
def	link_input (self, typenames, just_check=False, kwargs)
	link or check for inputs 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
	inputs
	a mapping of typename to a list of input objects
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.fcsttask.FcstTask.__init__	(		self,
			dstore,
			conf,
			section,
			outdir = None,
			taskname = None,
			kwargs
	)

Creates a FcstTask object.

Creates a new FcstTask object. All parameters are passed to the superclass constructor, hwrf.hwrftask.HWRFTask.__init__()

Definition at line 372 of file fcsttask.py.

Member Function Documentation

def hwrf.fcsttask.FcstTask.add_input	(		self,
			typename,
			inobj
	)

add input of a specified type

Adds an input of the given type typename that should be provided by the given object. The object should be a subclass of Input2Fcst.

Parameters

typename	the type of input
inobj	the Input2Fcst object that will provide the input

Definition at line 393 of file fcsttask.py.

Referenced by hwrf.fcsttask.WRFTaskBase.add_fort65(), hwrf.fcsttask.WRFTaskBase.add_geogrid(), hwrf.finalmergetask.FinalMergeTask.add_merge(), hwrf.fcsttask.WRFTaskBase.add_metgrid(), hwrf.fcsttask.WRFTaskBase.add_prep_hybrid(), hwrf.fcsttask.WRFTaskBase.add_wrfanl(), hwrf.fcsttask.WRFTaskBase.add_wrfbdy(), hwrf.multistorm.RealInit.add_wrfinput(), hwrf.finalmergetask.FinalMergeTask.add_wrfinput(), and hwrf.fcsttask.WRFTaskBase.add_wrfinput().

def hwrf.fcsttask.FcstTask.check_input	(		self,
			typenames,
			kwargs
	)

check if input data is available

Checks all inputs of the given typenames to make sure link_input would work if called with the same parameters. Returns True if link_input should succeed, and False if it would fail. This is a simple wrapper around link_input with just_check=True. However, subclasses may override this to perform additional checks, such as for a coupled model.

Parameters

typenames

a list of typenames that were sent to add_input

Returns

True if all inputs are available, and False otherwise

Parameters

kwargs

passed to link_input()

Definition at line 403 of file fcsttask.py.

def hwrf.fcsttask.FcstTask.has_input	(		self,
			typename
	)

is there any input data of this type to this task?

Returns True if there is at least one input source for the specified input type. That is, if someone called add_input(typename,(something)). Returns False otherwise.

Parameters

typename

the typename value that was sent to add_input

Returns

True if add_input was called with that typename, or False otherwise.

Definition at line 382 of file fcsttask.py.

Referenced by hwrf.fcsttask.WRFTaskBase.use_prep_hybrid().

def hwrf.fcsttask.FcstTask.link_input	(		self,
			typenames,
			just_check = False,
			kwargs
	)

link or check for inputs

Links all inputs of types given in typenames (an iterable) by calling obj.get_inputs on anything sent to self.add_input. If multiple input sources are available for a given input type, then only the first one that has input is used.

Do not use the just_check option: it is part of the internal implementation of check_input; if you need to just check the inputs, use check_input instead. If just_check=True, then nothing is linked. Instead, the routine just checks to see if the inputs are available. That is the same as calling check_input. However, subclasses may override check_input to check additional inputs as part of a coupled model.

Parameters

typenames	a list of typenames to check, as sent to add_inputs()
kwargs	passed to Input2Fcst.get_inputs()
just_check	if True, just check for data, do not link. Do not use this argument - it is part of the internal implementation of this class. If you want to check for inputs, call check_input() instead, as subclasses may override that function to provide additional checks.

Definition at line 417 of file fcsttask.py.

Referenced by hwrf.fcsttask.FcstTask.check_input(), and hwrf.fcsttask.WRFTaskBase.link_all_inputs().

---

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

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