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

This is a HWRF task that encapsulates stage 3 of the vortex relocation which relocates and pastes the vortexes together from various sources. More...

Detailed Description

This is a HWRF task that encapsulates stage 3 of the vortex relocation which relocates and pastes the vortexes together from various sources.

Definition at line 1583 of file relocate.py.

Inheritance diagram for hwrf.relocate.Stage3:
hwrf.relocate.RelocationTask hwrf.hwrftask.HWRFTask produtil.datastore.Task produtil.datastore.Datum

Public Member Functions

def __init__ (self, dstore, conf, section, sim, domains, taskname=None, kwargs)
 Stage3 constructor. More...
 
def get_ghost (self, domain)
 Returns Product objects for the ghost domain output file for the specified domain. More...
 
def get_wrfout (self, domain)
 
def wrfinput_at_time (self, atime, domain)
 Returns a Product object for the wrfinput output file for the specified domain if the atime matches this object's self.sim.simstart() More...
 
def wrfanl_at_time (self, atime, domain)
 Returns a Product object for the wrfanl output file for the specified domain if the atime matches this objects' self.sim.simstart(). More...
 
def get_wrfanl (self, domain)
 Returns a Product object for the wrfanl output file for the specified domain. More...
 
def get_wrfinput
 Returns a Product object for the wrfinput output file. More...
 
def get_storm_radius (self)
 Returns a Product for the storm radius file. More...
 
def get_track (self)
 Returns a Product for the track file. More...
 
def products
 Iterates over all products, or all selected products. More...
 
def run (self)
 Runs stage 3 of the vortex relocation. More...
 
def weak_cold_run (self)
 Runs the portion of the relocation that is used for weak, cold storms. More...
 
def cycled_or_weak_run (self)
 Runs the portion of the relocation that is run for cycled or weak storms. More...
 
def ensda_relocate_run (self)
 
def anl_4x
 Runs the anl_4x programs. More...
 
def anl_cs_10m (self)
 Runs the anl_cs_10m fortran program. More...
 
def anl_bogus_10m (self)
 Runs the anl_bogus_10m fortran program. More...
 
def pert_ct_weak (self)
 Runs hwrf_pert_ct for the weak storm case. More...
 
def pert_ct_gfs (self)
 Runs hwrf_pert_ct for the gfs vortex case. More...
 
def inter_2to2 (self)
 Runs the hwrf_inter_2to2 program. More...
 
def inter_2to2_again (self)
 Runs the hwrf_inter_2to2 program again. More...
 
def inter_4to6 (self)
 Runs the hwrf_inter_4to6 program. More...
 
def update_3dvar (self)
 Runs the hwrf_diffwrf_3dvar to update the output files. More...
 
def create_track (self)
 Runs the create_trak_fnl program. More...
 
- Public Member Functions inherited from hwrf.relocate.RelocationTask
def __init__ (self, dstore, conf, section, sim, domains, taskname=None, modin='GDAS1', wrfanl=None, wrfghost=None, wrfinput=None, parentTrack=None, trackName='track0', ghost_domains=None, dest_dir=None, gsi_d02=None, gsi_d03=None, gsi_d01=None, cycling_interval=-6 *3600, info=None, fgat_times=None, centrack=None, ensda=None, kwargs)
 RelocationTask constructor. More...
 
def get_wrfinput
 Returns the wrfinput output Product for the specified domain, or None if no such domain is known. More...
 
def get_wrfanl (self, domain)
 Returns the wrfanl output Product for this Task for the specified domain or None if no such product exists. More...
 
def get_ghost (self, domain)
 Returns the wrfghost output Product for this Task for the specified domain. More...
 
def wrfinput_at_time (self, atime, domain)
 Returns the wrfinput output file for the specified time and domain, or returns None if no such file exists. More...
 
def wrfanl_at_time (self, atime, domain)
 Returns the wrfanl output file for the specified time and domain, or None if no such file exists. More...
 
def copy_fixed (self)
 Copies the fixed files to the local directory. More...
 
def delete_temp (self)
 Deletes all temporary files created by the relocation jobs. More...
 
def products (self)
 Iterates over all products generated by this task. More...
 
def deliver_products (self, missing=None, logger=None, keep=False, frominfo=None, kwargs)
 Delivers products to intercom via Product.deliver. More...
 
def write_vitals
 Writes the tcvitals (from self.storminfo) to the specified file. More...
 
def make_ghost_namelist
 Writes the ghost namelist to namelist_ghost.input. More...
 
def make_analysis_namelist
 Writes the analysis namelist to namelist_analysis.input. More...
 
def parent_track (self)
 The Product object for the parent track file. More...
 
def modin (self)
 The DA mode. More...
 
def vortex (self)
 The vortex origin status. More...
 
def warm (self)
 The status of the current cycle. More...
 
def prev_cycle_dir (self)
 The previous cycle's COM directory. More...
 
def prev_cycle_sid (self)
 
def storm_intensity (self)
 The storm intensity. More...
 
def storm_basin (self)
 The storm basin. More...
 
def center_lat (self)
 The domain center latitude. More...
 
def center_lon (self)
 The domain center longitude. More...
 
def storm_id (self)
 The storm ID. More...
 
def fhr (self)
 The forecast hour. More...
 
def rinfo (self)
 The RelocationInfo. More...
 
def copy_inputs (self)
 Copies, or makes, one or more input files. More...
 
def set_ensda (self, ensda)
 
def get_centrack (self)
 Returns the Product for the center FGAT time track file if available, or otherwise the parent track file Product. More...
 
def set_centrack (self, centrack)
 Sets the Product for the center FGAT time track file. More...
 
def del_centrack (self)
 Unsets the center FGAT time track file so that get_centrack() will return the parent track file instead. More...
 
def create_atcf (self, case)
 Gets the parent vortex track file, either from a specified directory or from the tracker, run by a previous hwrf.init.HWRFInit object's tracker member. More...
 
def run_ext
 Helper function for running Fortran programs that need fort. 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

 gfs_flag
 Initialization flag variable relating to parent model vortex usage. More...
 
 state
 
 modin
 Input model: GFS or GDAS.
 
- Public Attributes inherited from hwrf.relocate.RelocationTask
 info
 A RelocationInfo object to trade relocation information with other stages of the relocation. More...
 
 fgat_times
 The list of FGAT hours. More...
 
 cycling_interval
 The positive datetime.timedelta time between cycles. More...
 
 sim
 The hwrf.wrf.WRFSimulation describing the WRF simulation.
 
 domains
 The list of domains from sim that match the domains with the same name provided to the constructor. More...
 
 dt_epsilon
 An epsilon value for time equality comparisons.
 
 ghost_domains
 The list of ghost domains passed to the constructor. More...
 
 dest_dir
 Delivery directory for outputs. More...
 
 modin
 The input model: GFS or GDAS1.
 
- 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.relocate.RelocationTask
 centrack
 The track file for the center FGAT hour. 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.relocate.Stage3.__init__ (   self,
  dstore,
  conf,
  section,
  sim,
  domains,
  taskname = None,
  kwargs 
)

Stage3 constructor.

Parameters
dstore,conf,section,sim,domains,taskname,kwargsPassed to the RelocationTask.__init__()

Definition at line 1588 of file relocate.py.

Member Function Documentation

def hwrf.relocate.Stage3.anl_4x (   self,
  case = 2 
)

Runs the anl_4x programs.

Parameters
case1 or 2: why is anl_4x being run.

Definition at line 1881 of file relocate.py.

Referenced by hwrf.relocate.Stage3.cycled_or_weak_run(), and hwrf.relocate.Stage3.ensda_relocate_run().

def hwrf.relocate.Stage3.anl_bogus_10m (   self)

Runs the anl_bogus_10m fortran program.

Definition at line 1974 of file relocate.py.

def hwrf.relocate.Stage3.anl_cs_10m (   self)

Runs the anl_cs_10m fortran program.

Definition at line 1939 of file relocate.py.

def hwrf.relocate.Stage3.create_track (   self)

Runs the create_trak_fnl program.

Definition at line 2171 of file relocate.py.

Referenced by hwrf.relocate.Stage3.weak_cold_run().

def hwrf.relocate.Stage3.cycled_or_weak_run (   self)

Runs the portion of the relocation that is run for cycled or weak storms.

Definition at line 1858 of file relocate.py.

def hwrf.relocate.Stage3.ensda_relocate_run (   self)
Runs relocation for ensemble member

Definition at line 1876 of file relocate.py.

def hwrf.relocate.Stage3.get_ghost (   self,
  domain 
)

Returns Product objects for the ghost domain output file for the specified domain.

Parameters
domainthe domain of interest

Definition at line 1620 of file relocate.py.

def hwrf.relocate.Stage3.get_storm_radius (   self)

Returns a Product for the storm radius file.

Definition at line 1718 of file relocate.py.

Referenced by hwrf.relocate.Stage3.products().

def hwrf.relocate.Stage3.get_track (   self)

Returns a Product for the track file.

Definition at line 1722 of file relocate.py.

def hwrf.relocate.Stage3.get_wrfanl (   self,
  domain 
)

Returns a Product object for the wrfanl output file for the specified domain.

Parameters
domainthe domain of interest

Definition at line 1701 of file relocate.py.

def hwrf.relocate.Stage3.get_wrfinput (   self,
  domain = None 
)

Returns a Product object for the wrfinput output file.

If a domain is specified, and is not the correct MOAD, then None is returned.

Parameters
domainthe domain of interest

Definition at line 1710 of file relocate.py.

def hwrf.relocate.Stage3.inter_2to2 (   self)

Runs the hwrf_inter_2to2 program.

Definition at line 2079 of file relocate.py.

Referenced by hwrf.relocate.Merge.run().

def hwrf.relocate.Stage3.inter_2to2_again (   self)

Runs the hwrf_inter_2to2 program again.

Definition at line 2100 of file relocate.py.

def hwrf.relocate.Stage3.inter_4to6 (   self)

Runs the hwrf_inter_4to6 program.

Definition at line 2122 of file relocate.py.

def hwrf.relocate.Stage3.pert_ct_gfs (   self)

Runs hwrf_pert_ct for the gfs vortex case.

Definition at line 2039 of file relocate.py.

def hwrf.relocate.Stage3.pert_ct_weak (   self)

Runs hwrf_pert_ct for the weak storm case.

Definition at line 2003 of file relocate.py.

Referenced by hwrf.relocate.Stage3.weak_cold_run().

def hwrf.relocate.Stage3.products (   self,
  domains = None 
)

Iterates over all products, or all selected products.

Parameters
domainsIf an iterable of domains is given, only iterates over products for those domains.

Definition at line 1726 of file relocate.py.

Referenced by hwrf.wrf.ExternalWRFTask.__init__(), hwrf.tracker.TrackerTask.call_completed_callbacks(), hwrf.wps.WPSTask.deliver_products(), hwrf.wps.WPSTask.undeliver_products(), hwrf.wrf.ExternalWRFTask.unrun(), and hwrf.wrf.ExternalWRFTask.wrf_check().

def hwrf.relocate.Stage3.run (   self)

Runs stage 3 of the vortex relocation.

Definition at line 1774 of file relocate.py.

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

def hwrf.relocate.Stage3.update_3dvar (   self)

Runs the hwrf_diffwrf_3dvar to update the output files.

Definition at line 2140 of file relocate.py.

Referenced by hwrf.relocate.Merge.run().

def hwrf.relocate.Stage3.weak_cold_run (   self)

Runs the portion of the relocation that is used for weak, cold storms.

Definition at line 1844 of file relocate.py.

def hwrf.relocate.Stage3.wrfanl_at_time (   self,
  atime,
  domain 
)

Returns a Product object for the wrfanl output file for the specified domain if the atime matches this objects' self.sim.simstart().

Parameters
atimethe time of interest
domainthe domain of interest

Definition at line 1686 of file relocate.py.

def hwrf.relocate.Stage3.wrfinput_at_time (   self,
  atime,
  domain 
)

Returns a Product object for the wrfinput output file for the specified domain if the atime matches this object's self.sim.simstart()

Parameters
atimethe time of interest
domainthe domain of interest

Definition at line 1669 of file relocate.py.

Member Data Documentation

hwrf.relocate.Stage3.gfs_flag

Initialization flag variable relating to parent model vortex usage.

Definition at line 1797 of file relocate.py.

Referenced by hwrf.relocate.Stage3.anl_4x(), hwrf.relocate.Stage3.cycled_or_weak_run(), and hwrf.relocate.Stage3.weak_cold_run().


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