|
HWRF
trunk@4391
|
The uncoupled HWRF forecast Task. More...
The uncoupled HWRF forecast Task.
This class runs an atmosphere-only WRF run, using wrfanl files from a prior WRFAnl simulation. It encapsulates an ExternalWRFTask, which performs the actual tracking of products. This allows the post-processors and wrf copy tasks to keep track of the model's output while the model is running. That subtask shows up as ".mon" (for "monitor") relative to this task (so if this task is wrfatmos, then the external task is wrfatmos.mon).
Definition at line 1544 of file fcsttask.py.
Public Member Functions | |
| def | __init__ (self, dstore, conf, section, wrf, keeprun=True, wrfdiag_stream='auxhist1', kwargs) |
| WRFAtmos constructor. More... | |
| def | make_wrf (self, wrf) |
| creates a WRFSimulation for an uncoupled forecast run More... | |
| def | unrun (self) |
| deletes output files More... | |
| def | run (self) |
| runs the uncoupled WRF forecast More... | |
| def | products (self, kwargs) |
| iterates over all WRF products. More... | |
| def | exproducts (self, kwargs) |
| iterates over all WRF products. More... | |
| def | wrf_check (self, kwargs) |
| checks the status of the WRF simulation. More... | |
| def | run_exe |
| runs the wrf program More... | |
| def | update_state (self) |
| checks the wrf state and updates it in the HWRF database file More... | |
| def | deliver_products (self, args, kwargs) |
| does nothing 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 | |
| state | |
| runs the uncoupled WRF forecast More... | |
| 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... | |
| def hwrf.fcsttask.WRFAtmos.__init__ | ( | self, | |
| dstore, | |||
| conf, | |||
| section, | |||
| wrf, | |||
keeprun = True, |
|||
wrfdiag_stream = 'auxhist1', |
|||
| kwargs | |||
| ) |
WRFAtmos constructor.
The constructor for WRFAtmos.
| dstore | the produtil.datastore.Datastore object |
| conf | the HWRFConfig object for configuration information |
| section | the section name within that HWRFConfig object |
| wrf | the hwrf.wrf.WRFSimulation that is to be executed |
| keeprun | True means the output directory should NOT be deleted |
| wrfdiag_stream | stream that generates wrfdiag files |
| kwargs | passed to the parent class constructor. |
Definition at line 1555 of file fcsttask.py.
| def hwrf.fcsttask.WRFAtmos.deliver_products | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
does nothing
Has no effect. This is present only because it is a requirement of the parent class. No delivery is required because the products are all UpstreamFile objects, so the delivery state is set by the post-processors when calling the "check" function of each product.
| args,kwargs | ignored |
Definition at line 1664 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.WRFAtmos.exproducts | ( | self, | |
| kwargs | |||
| ) |
iterates over all WRF products.
Synonym for products(). Iterates over all WRF products. See the hwrf.wrf.ExternalWRFTask.products() for details.
| kwargs | passed to hwrf.wrf.ExternalWRFTask.products() |
Definition at line 1617 of file fcsttask.py.
| def hwrf.fcsttask.WRFAtmos.make_wrf | ( | self, | |
| wrf | |||
| ) |
creates a WRFSimulation for an uncoupled forecast run
Creates a WRFSimulation for an uncoupled forecast run. Runs the superclass WRFAtmos.make_wrf. Instructs the resulting WRFSimulation to take analysis files as input, and calls the _set_wrf_proc_config to set I/O server and compute grid dimensions.
| wrf | the wrf argument to init |
Definition at line 1578 of file fcsttask.py.
| def hwrf.fcsttask.WRFAtmos.products | ( | self, | |
| kwargs | |||
| ) |
iterates over all WRF products.
Iterates over all WRF products. See the hwrf.wrf.ExternalWRFTask.products() for details.
| kwargs | passed to hwrf.wrf.ExternalWRFTask.products() |
Definition at line 1609 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.WRFAtmos.run | ( | self | ) |
runs the uncoupled WRF forecast
Performs all work needed to run the program. Sets the state to produtil.datastore.UNSTARTED. Creates the work directory, CD's to it, runs the initial_prerun, link_fix, link_all_inputs, make_namelist, final_prerun, run_exe, postrun and deliver_products.
Definition at line 1598 of file fcsttask.py.
Referenced by produtil.datastore.Task.runpart().
| def hwrf.fcsttask.WRFAtmos.run_exe | ( | self, | |
exename = 'wrf', |
|||
not_allranks = False, |
|||
runner = None, |
|||
sleeptime = None |
|||
| ) |
runs the wrf program
Called from run(), this runs the wrf program after the directory is set up.
| exename | sent to getexe() to get the path to wrf if runner is unspecified |
| not_allranks | if True, only use one MPI rank. Do not use. |
| runner | an alternative produtil.prog.Runner to execute. |
| sleeptime | seconds to sleep between checks of the wrf executables completion. The default sleeptime, if none is specified is 60 seconds rather than the usual 30. |
Definition at line 1637 of file fcsttask.py.
Referenced by hwrf.fcsttask.WRFAtmos.wrf_check().
| def hwrf.fcsttask.WRFAtmos.unrun | ( | self | ) |
deletes output files
Deletes output files. See the hwrf.wrf.ExternalWRFTask.unrun for details.
Definition at line 1592 of file fcsttask.py.
| def hwrf.fcsttask.WRFAtmos.update_state | ( | self | ) |
checks the wrf state and updates it in the HWRF database file
Checks the state of the WRF simulation and copies that information to self.state in the produtil.datastore.Datastore. See hwrf.wrf.ExternalWRFTask.update_state() for details.
Definition at line 1655 of file fcsttask.py.
Referenced by hwrf.finalmergetask.FinalMergeTask.run().
| def hwrf.fcsttask.WRFAtmos.wrf_check | ( | self, | |
| kwargs | |||
| ) |
checks the status of the WRF simulation.
Checks the status of the WRF simulation. Should only be used while the simulation is running. This is intended to be run by jobs other than the WRF job, such as the post-processors, to monitor the WRF simulation as it progresses.
| kwargs | passed to hwrf.wrf.ExternalWRFTask.wrf_check() |
Definition at line 1625 of file fcsttask.py.
| hwrf.fcsttask.WRFAtmos.state |
runs the uncoupled WRF forecast
checks the wrf state and updates it in the HWRF database file
Performs all work needed to run the program. Sets the state to produtil.datastore.UNSTARTED. Creates the work directory, CD's to it, runs the initial_prerun, link_fix, link_all_inputs, make_namelist, final_prerun, run_exe, postrun and deliver_products.
Checks the state of the WRF simulation and copies that information to self.state in the produtil.datastore.Datastore. See hwrf.wrf.ExternalWRFTask.update_state() for details.
Definition at line 1606 of file fcsttask.py.
Referenced by produtil.datastore.Task.completed(), produtil.datastore.Task.is_completed(), hwrf.mpipomtc.POMInit.run(), hwrf.ww3.WW3Init.run(), hwrf.hycom.HYCOMInit.run(), hwrf.finalmergetask.FinalMergeTask.run(), hwrf.nhc_products.NHCProducts.run(), hwrf.ww3.WW3Post.run(), hwrf.hycom.HYCOMPost.run(), hwrf.wps.Geogrid.run(), hwrf.relocate.Stage1.run(), hwrf.gsi.GSIBase.run(), hwrf.wps.Ungrib.run(), hwrf.wps.Metgrid.run(), hwrf.relocate.Stage2.run(), hwrf.gribtask.GRIBTask.run_helper(), hwrf.gribtask.GRIBTask.uncomplete(), hwrf.post.PostManyWRF.uncomplete(), hwrf.gribtask.GRIBTask.unrun(), hwrf.hycom.HYCOMPost.unrun(), hwrf.wrf.ExternalWRFTask.update_state(), and hwrf.fcsttask.WRFAtmos.update_state().
1.8.10
