HWRF  trunk@4391
Public Member Functions | Public Attributes | List of all members
hwrf.wps.Metgrid Class Reference

This is a HWRF task that horizontally interpolates the meteorological fields extracted by ungrib to the model grids defined by geogrid. More...

Detailed Description

This is a HWRF task that horizontally interpolates the meteorological fields extracted by ungrib to the model grids defined by geogrid.

It is a wrapper around the WPS metgrid.exe Fortran program.

Definition at line 1049 of file wps.py.

Inheritance diagram for hwrf.wps.Metgrid:
hwrf.wps.WPSTask hwrf.hwrftask.HWRFTask produtil.datastore.Task produtil.datastore.Datum

Public Member Functions

def __init__ (self, args, kwargs)
 Creates a new Metgrid. More...
 
def run (self)
 Copies inputs, runs metgrid, delivers outputs. More...
 
def met_at_time (self, when)
 Returns a FileProduct for the Metgrid file at the specified time or None if no such product is found. More...
 
def make_products (self)
 Generates FileProduct objects for this Metgrid. More...
 
- Public Member Functions inherited from hwrf.wps.WPSTask
def __init__ (self, dstore, conf, section, sim, domains, taskname=None, wpsdir=None, starttime=None, increment=None, endtime=None, parent_atime=None, geogrid_from=None, kwargs)
 Create a new WPSTask. More...
 
def io_suffix (self, stream)
 Guesses the file suffix (.nc, etc.) for the specified stream. More...
 
def getsim (self)
 The WRFSimulation object for which we are preparing input. More...
 
def check_geogrid (self)
 Checks to see if the geogrid MOAD output file is present and non-empty in the current working directory. More...
 
def link_geogrid (self)
 Links geogrid output from the specified Geogrid task to the current working directory. More...
 
def times (self)
 Iterates over all output times. More...
 
def domains (self)
 Iterates over the domains in this WPSTask.
 
def link_fix
 Links all fix files for ungrib to the current working directory. More...
 
def make_product_structure (self, stream)
 Generates the self._products data structure used by the products method. More...
 
def make_products (self)
 This subroutine should be implemented in subclasses. More...
 
def products
 Iterates over all products. More...
 
def make_namelist (self)
 Returns the namelist.wps contents as a string. More...
 
def undeliver_products
 Deletes all delivered products and marks them as unavailable. More...
 
def deliver_products
 This is called from self.run to deliver all 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...
 

Public Attributes

 endtime
 
 state
 
- Public Attributes inherited from hwrf.wps.WPSTask
 location
 
 nl
 an hwrf.namelist.Conf2Namelist with the namelist.wps information
 
 starttime
 Simulation start time. More...
 
 endtime
 Simulation end time. More...
 
 increment
 Simulation boundary input interval.
 
 parent_atime
 Parent model analysis time.
 
- 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.wps.WPSTask
 nocolons
 Read-only property that guesses whether colons should be omitted from filenames (True) or not (False) More...
 
 maxdom = property(_maxdom,None,None,"The number of WRF domains.")
 The number of WRF domains. More...
 
 MOAD = property(_MOAD,None,None,"Returns the Mother of All Domains (MOAD)")
 The Mother Of All Domains (MOAD) as an hwrf.wrf.WRFDomain.
 
 sim
 Read-only property: the hwrf.wrf.WRFSimulation for this WPSTask. 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.wps.Metgrid.__init__ (   self,
  args,
  kwargs 
)

Creates a new Metgrid.

Parameters
args,kwargsAll arguments are passed to the WPSTask.__init__() constructor.

Definition at line 1055 of file wps.py.

Member Function Documentation

def hwrf.wps.Metgrid.make_products (   self)

Generates FileProduct objects for this Metgrid.

This is called automatically from the constructor.

Definition at line 1116 of file wps.py.

def hwrf.wps.Metgrid.met_at_time (   self,
  when 
)

Returns a FileProduct for the Metgrid file at the specified time or None if no such product is found.

Parameters
whenthe time of interest

Definition at line 1108 of file wps.py.

def hwrf.wps.Metgrid.run (   self)

Copies inputs, runs metgrid, delivers outputs.

Note
Ungrib must have been run in the same directory beforehand. The Geogrid must have been run in the same directory, unless it was passed as input via geogrid_from= in the constructor.

Definition at line 1061 of file wps.py.

Referenced by produtil.datastore.Task.runpart().


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