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

Represents a two-dimensional ensemble-vs-time array of hwrf.hwrftask.HWRFTask objects. More...

Detailed Description

Represents a two-dimensional ensemble-vs-time array of hwrf.hwrftask.HWRFTask objects.

Definition at line 33 of file ensda.py.

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

Public Member Functions

def __init__ (self, dstore, conf, section, anlintime=None, taskname=None, kwargs)
 Constructor for DAEnsemble. More...
 
def anlintime (self)
 The time at the beginning of the first ensemble step. More...
 
def anlouttime (self)
 The time at the end of the last ensemble step. More...
 
def nmembers (self)
 The number of members of the ensemble. More...
 
def nsteps (self)
 The number of ensemble DA time steps. More...
 
def anlintimes (self)
 Iterates over all ensemble analysis input times. More...
 
def anlouttimes (self)
 Iterates over all ensemble analysis output times. More...
 
def member_ids (self)
 Iterates over all member ids. More...
 
def set_member (self, atime, enkfmem, task)
 sets the HWRFTask to use to use for one cycle of one member More...
 
def members_at_time (self, atime)
 iterate over members for a specified analysis input time More...
 
def members_at_anlouttime (self)
 iterate over members at the final analysis output time. More...
 
def steps_for_member (self, enkfmem)
 iterate over analysis cycles for a specific member More...
 
def member (self, atime, enkfmem)
 get the analysis cycle for the specified member and time More...
 
def inputiter (self)
 iterate over all needed input data, for hwrf.input More...
 
def dump (self)
 print detailed diagnostics 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.ensda.DAEnsemble.__init__ (   self,
  dstore,
  conf,
  section,
  anlintime = None,
  taskname = None,
  kwargs 
)

Constructor for DAEnsemble.

Parameters
dstorethe produtil.datastore.Datastore database to use
confthe hwrf.config.HWRFConfig for configuration info
sectionthe section to use in conf
anlintimethe analysis input time
tasknamethe name of this task in the database
kwargspassed to the superclass constructor

Definition at line 37 of file ensda.py.

Member Function Documentation

def hwrf.ensda.DAEnsemble.anlintime (   self)

The time at the beginning of the first ensemble step.

Definition at line 65 of file ensda.py.

def hwrf.ensda.DAEnsemble.anlintimes (   self)

Iterates over all ensemble analysis input times.

Definition at line 85 of file ensda.py.

def hwrf.ensda.DAEnsemble.anlouttime (   self)

The time at the end of the last ensemble step.

Definition at line 70 of file ensda.py.

Referenced by hwrf.fcsttask.AnalysisCycle.deliver_products().

def hwrf.ensda.DAEnsemble.anlouttimes (   self)

Iterates over all ensemble analysis output times.

Definition at line 91 of file ensda.py.

def hwrf.ensda.DAEnsemble.dump (   self)

print detailed diagnostics

Sends detailed diagnostics about all members to the print() statement. This is intended for debugging only.

Definition at line 163 of file ensda.py.

def hwrf.ensda.DAEnsemble.inputiter (   self)

iterate over all needed input data, for hwrf.input

Calls inputiter for all steps of all ENKF members. This is for use by the hwrf.input to figure out what input data is required for the DA ensemble.

Definition at line 152 of file ensda.py.

def hwrf.ensda.DAEnsemble.member (   self,
  atime,
  enkfmem 
)

get the analysis cycle for the specified member and time

Returns the da cycle for member enkfmem at analysis input time atime.

Parameters
atimethe analysis time, a datetime.datetime
enkfmemthe ensemble id

Definition at line 143 of file ensda.py.

def hwrf.ensda.DAEnsemble.member_ids (   self)

Iterates over all member ids.

Definition at line 101 of file ensda.py.

def hwrf.ensda.DAEnsemble.members_at_anlouttime (   self)

iterate over members at the final analysis output time.

Iterates over all members at the final analysis output time, yielding (id,member) tuples.

Definition at line 127 of file ensda.py.

def hwrf.ensda.DAEnsemble.members_at_time (   self,
  atime 
)

iterate over members for a specified analysis input time

Iterates over all members at the specified anlintime, yielding (id,member) tuples.

Parameters
atimethe analysis time, a datetime.datetime

Definition at line 117 of file ensda.py.

Referenced by hwrf.ensda.DAEnsemble.dump(), and hwrf.ensda.DAEnsemble.members_at_anlouttime().

def hwrf.ensda.DAEnsemble.nmembers (   self)

The number of members of the ensemble.

Definition at line 75 of file ensda.py.

def hwrf.ensda.DAEnsemble.nsteps (   self)

The number of ensemble DA time steps.

Definition at line 80 of file ensda.py.

def hwrf.ensda.DAEnsemble.set_member (   self,
  atime,
  enkfmem,
  task 
)

sets the HWRFTask to use to use for one cycle of one member

Tells member enkfmem to use the specified task to produce output whose input analysis time is atime.

Parameters
atimethe analysis time, a datetime.datetime
enkfmemthe enkf member id
taskthe HWRFTask to use

Definition at line 106 of file ensda.py.

def hwrf.ensda.DAEnsemble.steps_for_member (   self,
  enkfmem 
)

iterate over analysis cycles for a specific member

Iterates over (time,EnsembleDAMemberStep) pairs for the specified member.

Definition at line 135 of file ensda.py.


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