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

Forecast ensemble member based on the GFS ENKF. More...

Detailed Description

Forecast ensemble member based on the GFS ENKF.

Runs one member of an ensemble DA forecast ensemble, using a member of the GFS ENKF ensemble as initial and boundary conditions. Some data from the earlier deterministic forecast jobs is reused to simplify the process.

Definition at line 286 of file ensda.py.

Inheritance diagram for hwrf.ensda.FromGFSENKF:
hwrf.hwrftask.HWRFTask produtil.datastore.Task produtil.datastore.Datum

Public Member Functions

def __init__ (self, dstore, conf, section, detinit, enkfmem, sim, taskname=None, track=None, relocate=None, priorcycle=None, kwargs)
 Constructor for FromGFSENKF. More...
 
def anlintime (self)
 The analysis input time. More...
 
def make_wrf (self, detinit, sim)
 Create the wrf() and fcst. More...
 
def make_fcst (self, detinit)
 Adds input sources to the forecast object. More...
 
def sim (self)
 The wrf simulation made by make_wrf()
 
def inputiter (self)
 Passes control to the hwrf.prep.PrepHybrid.inputiter(). More...
 
def make_init (self, detinit)
 Creates initialization tasks. More...
 
def products (self, kwargs)
 Iterates over all forecast products. More...
 
def run (self)
 Runs the initialization and forecast for this ensemble member. More...
 
def run_relocate (self)
 
- 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

 enkfmem
 the enkf member id
 
 track
 
 relocate
 
 fcst
 the forecast task, an hwrf.fcsttask.AnalysisCycle
 
 geogrid
 the geogrid task from the deterministic initialization
 
 metgrid
 the metgrid task from the deterministic initialization
 
 prep
 the hwrf.prep.PrepHybrid that processes the GFS ENKF forecast and analysis spectral data
 
 realinit
 the hwrf.fcsttask.RealNMM that generates wrfinput_d01 and wrfbdy_d01 files for input to the fcst and wrfanl
 
 wrfanl
 the hwrf.fcsttask.WRFAnl that generates input wrfanl_d* files for input to the fcst
 
 post
 
 gribber
 
 tracker
 
 state
 
 relocation
 
 rstage1
 
 rstage3
 
- 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.ensda.FromGFSENKF.__init__ (   self,
  dstore,
  conf,
  section,
  detinit,
  enkfmem,
  sim,
  taskname = None,
  track = None,
  relocate = None,
  priorcycle = None,
  kwargs 
)

Constructor for FromGFSENKF.

Parameters
dstorethe produtil.datastore.Datastore database to use
confthe hwrf.config.HWRFConfig that provides configuration data
sectionthe section in conf to use
detinitthe deterministic initialization, an hwrf.init.HWRFInit or hwrf.init.InitBeforeGSI object.
enkfmemthe ensemble member id
simthe hwrf.wrf.WRFSimulation object
tasknamethe name of the task within the database
kwargspassed to the parent class constructor Constructor for FromGFSENKF
dstorethe produtil.datastore.Datastore database to use
confthe hwrf.config.HWRFConfig that provides configuration data
sectionthe section in conf to use
detinitthe deterministic initialization, an hwrf.init.HWRFInit or hwrf.init.InitBeforeGSI object.
enkfmemthe ensemble member id
simthe hwrf.wrf.WRFSimulation object
tasknamethe name of the task within the database
kwargspassed to the parent class constructor

Definition at line 296 of file ensda.py.

Member Function Documentation

def hwrf.ensda.FromGFSENKF.anlintime (   self)

The analysis input time.

Definition at line 366 of file ensda.py.

def hwrf.ensda.FromGFSENKF.inputiter (   self)

Passes control to the hwrf.prep.PrepHybrid.inputiter().

Iterates over the prep member's inputiter, a hwrf.prep.PrepHybrid.inputiter(). Yields all input data information needed by the hwrf.input module to pull input data.

Definition at line 417 of file ensda.py.

def hwrf.ensda.FromGFSENKF.make_fcst (   self,
  detinit 
)

Adds input sources to the forecast object.

Adds metgrid, geogrid, wrfinput, wrfbdy, wrfanl, and coupler fort.65 input to the fcst member variable.

Parameters
delinitthe deterministic model initialization, an hwrf.init.HWRFInit or hwrf.init.InitBeforeGSI. Adds input sources to the forecast object.

Adds metgrid, geogrid, wrfinput, wrfbdy, wrfanl, and coupler fort.65 input to the fcst member variable.

Parameters
delinitthe deterministic model initialization, an hwrf.init.HWRFInit or hwrf.init.InitBeforeGSI.

Definition at line 388 of file ensda.py.

def hwrf.ensda.FromGFSENKF.make_init (   self,
  detinit 
)

Creates initialization tasks.

Called from the constructor. Creates the initialization tasks, prep, realinit and wrfanl; and links to the deterministic init geogrid and metgrid tasks. This is called by the constructor, to create the needed inputs to the fcst member.

Parameters
detinitthe deterministic model initialization, an hwrf.init.HWRFInit or hwrf.init.InitBeforeGSI.

Definition at line 426 of file ensda.py.

def hwrf.ensda.FromGFSENKF.make_wrf (   self,
  detinit,
  sim 
)

Create the wrf() and fcst.

This function, called from the constructor, creates the hwrf.wrf.WRFSimulation and hwrf.fcsttask.AnalysisCycle used for this forecast.

Parameters
detinitthe deterministic model initialization, an hwrf.init.HWRFInit or hwrf.init.InitBeforeGSI.
simthe hwrf.wrf.WRFSimulation passed to the constructor.

Definition at line 370 of file ensda.py.

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

def hwrf.ensda.FromGFSENKF.products (   self,
  kwargs 
)
def hwrf.ensda.FromGFSENKF.run (   self)

Runs the initialization and forecast for this ensemble member.

Runs the prep, realinit, wrfanl and fcst member tasks, using input from the GFS ENKF, and the deterministic initialization.

Definition at line 533 of file ensda.py.

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

def hwrf.ensda.FromGFSENKF.run_relocate (   self)
Runs the relocate jobs, if present.

Definition at line 595 of file ensda.py.

Referenced by hwrf.init.HWRFInit.run().


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