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

runs wrfanl and generates a track file More...

Detailed Description

runs wrfanl and generates a track file

This subtask of WRFAnl modifies the time of the 1 minute forecast wrfout file from the outer domain to have the analysis time instead so that the tracker can be run to get the initial storm location.

Definition at line 1343 of file fcsttask.py.

Inheritance diagram for hwrf.fcsttask.WRFAnl4Trak:
hwrf.fcsttask.WRFAnl hwrf.fcsttask.WRFTaskBase hwrf.fcsttask.FcstTask hwrf.hwrftask.HWRFTask produtil.datastore.Task produtil.datastore.Datum hwrf.fcsttask.WRFGhostForPost

Public Member Functions

def __init__ (self, dstore, conf, section, wrf, trakdoms=JUST_MOAD, trakname='trankin_d< domain >', kwargs)
 constructor More...
 
def track_domains (self)
 iterates over track input domains More...
 
def make_products (self)
 creates Product objects for deliver_products() and products() More...
 
def postrun (self)
 modifies trakin_* files to say they're at time 0 More...
 
def retime_wrfout (self, domain)
 modifies a trakin file's internal timestamp More...
 
def deliver_products (self)
 delivers products More...
 
def get_trackin
 returns a trakin (trackin) Product More...
 
def products
 iterates over all products from this task. More...
 
- Public Member Functions inherited from hwrf.fcsttask.WRFAnl
def make_wrf (self, wrf)
 creates the WRFSimulation object (self.wrf()) More...
 
def anltime (self)
 the time for which analysis files are generated. More...
 
def make_products (self)
 creates FileProduct objects for all wrfanl files. More...
 
def get_wrfanl (self, domain)
 returns the wrfanl product for the specified domain More...
 
def wrfanl_at_time (self, atime, domain)
 get a wrfanl file for a specified domain and analysis time More...
 
def deliver_products (self)
 delivers products during a call to run() More...
 
def products
 iterates over products Iterates over all Product objects that were identified by make_products. More...
 
- Public Member Functions inherited from hwrf.fcsttask.WRFTaskBase
def __init__ (self, dstore, conf, section, wrf, keeprun=True, kwargs)
 constructor More...
 
def make_wrf (self, wrf)
 creates a WRFSimulation object for this class More...
 
def add_geogrid (self, g)
 adds a geogrid input source More...
 
def add_metgrid (self, m)
 adds a metgrid input source More...
 
def add_prep_hybrid (self, p)
 adds a prep_hybrid input source More...
 
def use_prep_hybrid (self)
 returns True if prep_hybrid was requested, and False otherwise. More...
 
def add_wrfinput (self, r)
 adds a wrfinput_d01 input source More...
 
def add_wrfbdy (self, r)
 adds a wrfbdy_d01 input source More...
 
def add_fort65 (self, r)
 adds a coupler fort.65 input source More...
 
def add_real (self, r)
 add a fort.65, wrfinput_d01 and wrfbdy_d01 input source More...
 
def add_wrfanl (self, r, domain)
 add a wrfanl input source for a specific domain More...
 
def make_products (self)
 called from constructor, creates Products More...
 
def link_fix (self)
 links or copies fixed data files More...
 
def check_all_inputs (self)
 Checks to see if all needed input is available. More...
 
def link_all_inputs
 Links all inputs provided by the various add_* member functions. More...
 
def need_all_metgrid (self)
 Returns True if all metgrid files are needed as input to this Task.
 
def run_exe
 runs the executable More...
 
def final_prerun (self)
 last step before running executable More...
 
def initial_prerun (self)
 called immediately after cding to a scrub directory More...
 
def run (self)
 run the wrf or real_nmm More...
 
def postrun (self)
 called just after run_exe() succeeds. More...
 
def deliver_products (self)
 delivers products to their destinations More...
 
def make_namelist
 generates the wrf namelist.input file More...
 
def wrf (self)
 Returns the WRFSimulation object used by this task. More...
 
def sim (self)
 Returns the WRFSimulation object used by this task. More...
 
- Public Member Functions inherited from hwrf.fcsttask.FcstTask
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

 trackin_name
 mapping from WRFDomain to product name for trakin files
 
 trackin_prod
 mapping from WRFDomain to product for trakin files
 
- Public Attributes inherited from hwrf.fcsttask.WRFTaskBase
 dt_epsilon
 epsilon value for time equality comparisons
 
 keeprun
 if False, temporary files are deleted, otherwise they're kept
 
 location
 
- Public Attributes inherited from hwrf.fcsttask.FcstTask
 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.WRFAnl4Trak.__init__ (   self,
  dstore,
  conf,
  section,
  wrf,
  trakdoms = JUST_MOAD,
  trakname = 'trankin_d<domain>',
  kwargs 
)

constructor

Constructor for WRFAnl4Trak.

Parameters
trakdomswhat domains should be used for the tracks? either JUST_MOAD or ALL_DOMS or a list of WRFDomain objects
traknamethe track output filename.
dstore,conf,section,wrf,kwargspassed to superclass constructor

Definition at line 1351 of file fcsttask.py.

Member Function Documentation

def hwrf.fcsttask.WRFAnl4Trak.deliver_products (   self)

delivers products

Delivers all products (FileProduct objects) created by make_products, including the new trackin_d<domain> added by this subclass, and all products added by the superclass WRFAnl.

Definition at line 1442 of file fcsttask.py.

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

def hwrf.fcsttask.WRFAnl4Trak.get_trackin (   self,
  domain = None 
)

returns a trakin (trackin) Product

Returns a trakin (trackin) Product. If a domain is specified, returns the trackin file for that domain. Otherwise, the MOAD (outermost domain) is assumed.

Parameters
domainNone, or the domain of interest
Returns
a Product for the trakin file for the specified domain

Definition at line 1454 of file fcsttask.py.

Referenced by hwrf.fcsttask.WRFGhostForPost.get_ghout().

def hwrf.fcsttask.WRFAnl4Trak.make_products (   self)

creates Product objects for deliver_products() and products()

Called from constructor. This make_products adds all products produced by WRFAnl.make_products, but adds a product for the outer domain one minute forecast history stream (wrfout) file called "trackin_d<domain>". That file is intended to be used to generate the parent domain vortex information.

Definition at line 1373 of file fcsttask.py.

def hwrf.fcsttask.WRFAnl4Trak.postrun (   self)

modifies trakin_* files to say they're at time 0

Calls retime_wrfout for all domains whose trackin_d0X files are requested. This produces the modified 1 minute forecast wrfout files that lie and say they're from the analysis time.

Definition at line 1399 of file fcsttask.py.

def hwrf.fcsttask.WRFAnl4Trak.products (   self,
  domain = None,
  domains = None,
  time = None,
  stream = None 
)

iterates over all products from this task.

Iterates over all products from this task. This class adds the trackin_d0* files.

Parameters
domainthe domain of interest
domainsa list of domains of interest
timethe analysis time
streamthe output stream

Definition at line 1468 of file fcsttask.py.

Referenced by hwrf.wrf.ExternalWRFTask.__init__(), hwrf.tracker.TrackerTask.call_completed_callbacks(), hwrf.wps.WPSTask.deliver_products(), hwrf.relocate.RelocationTask.deliver_products(), hwrf.wps.WPSTask.undeliver_products(), hwrf.prep.PrepHybrid.unrun(), hwrf.post.PostManyWRF.unrun(), hwrf.wrf.ExternalWRFTask.unrun(), and hwrf.wrf.ExternalWRFTask.wrf_check().

def hwrf.fcsttask.WRFAnl4Trak.retime_wrfout (   self,
  domain 
)

modifies a trakin file's internal timestamp

If possible, modifies the stated output time in the one minute forecast trackin_d<domain> file to the analysis time. Does this for one domain. For intio files, it does not modify the file, but instead simply renames it. That is done because, at last test, the post does not actually look in an intio wrfout file for the time, so no modification is necessary.

Parameters
domainthe domain whose trakin file is being modified

Definition at line 1408 of file fcsttask.py.

Referenced by hwrf.fcsttask.WRFAnl4Trak.postrun().

def hwrf.fcsttask.WRFAnl4Trak.track_domains (   self)

iterates over track input domains

Iterates over domains specified by the trakdoms parameter to init().

Definition at line 1362 of file fcsttask.py.

Referenced by hwrf.fcsttask.WRFAnl4Trak.postrun().


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