HWRF
trunk@4391
|
Runs a WRF-POM coupled simulation. More...
Runs a WRF-POM coupled simulation.
Most of the work of this class is done by the superclass, WRFAtmos. This class adds code to copy the inputs needed by POM and the coupler. There are three critical new config section values:
Definition at line 360 of file mpipomtc.py.
Public Member Functions | |
def | __init__ (self, dstore, conf, section, wrf, keeprun=True, wrfdiag_stream='auxhist1', pominit=None, kwargs) |
WRFCoupledPOM constructor. More... | |
def | remove_ocean (self) |
Removes the ocean component from coupling. More... | |
def | pominit (self) |
Returns the POMInit object for this coupled forecast. More... | |
def | copy_pom_inputs |
Copies or checks for the inputs required by the POM model. More... | |
![]() | |
def | __init__ (self, dstore, conf, section, wrf, keeprun=True, wrfdiag_stream='auxhist1', kwargs) |
def | check_all_inputs |
def | link_all_inputs |
def | run |
def | run_exe (self) |
def | make_coupler_namelist |
def | coupleiter (self) |
Component manipulation. More... | |
def | couple |
def | remove_wave () |
def | remove_ocean () |
def | uncouple |
Removes a component, or all components, from the coupling. More... | |
def | component (self, which) |
def | order (self, name) |
def | add_coupled_stream (self, stream, times) |
Products. More... | |
def | add_coupled_product (self, stream, time, product) |
def | coupled_products |
def | products (self, domains=None, stream=None, time=None, kwargs) |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
Protected Member Functions | |
def | _add_wave (self) |
Internal function for adding wave coupling. More... | |
Additional Inherited Members | |
![]() | |
state | |
runs the uncoupled WRF forecast More... | |
![]() | |
dt_epsilon | |
epsilon value for time equality comparisons | |
keeprun | |
if False, temporary files are deleted, otherwise they're kept | |
location | |
![]() | |
inputs | |
a mapping of typename to a list of input objects | |
![]() | |
storminfo | |
The hwrf.storminfo.StormInfo describing the vitals information for the storm processed by this HWRFTask. More... | |
![]() | |
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... | |
![]() | |
state | |
Read-write property: the job state. More... | |
taskname | |
Read-only property: the name of this task. More... | |
![]() | |
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.mpipomtc.WRFCoupledPOM.__init__ | ( | self, | |
dstore, | |||
conf, | |||
section, | |||
wrf, | |||
keeprun = True , |
|||
wrfdiag_stream = 'auxhist1' , |
|||
pominit = None , |
|||
kwargs | |||
) |
WRFCoupledPOM constructor.
dstore | the produtil.datastore.Datastore to use |
conf | the hwrf.config.HWRFConfig that provides configuration ifnormation |
section | the config section in conf |
wrf | the hwrf.wrf.WRFSimulation object that is being run |
keeprun | if True, the simulation temporary files are retained |
wrfdiag_stream | the stream that generates wrfdiag files |
pominit | The POMInit object. |
kwargs | passed to hwrf.fcsttask.WRFAtmos.__init__ |
Definition at line 373 of file mpipomtc.py.
|
protected |
Internal function for adding wave coupling.
This must be implemented by a subclass.
Definition at line 410 of file mpipomtc.py.
Referenced by hwrf.mpipomtc.WRFCoupledPOM.__init__().
def hwrf.mpipomtc.WRFCoupledPOM.copy_pom_inputs | ( | self, | |
just_check = False |
|||
) |
Copies or checks for the inputs required by the POM model.
This is an internal function used by the PomIniter class. Do not call directly.
just_check | If just_check=True, the inputs are not copied; instead, the routine just checks for them. Do not use just_check: call check_inputs instead. |
Definition at line 416 of file mpipomtc.py.
def hwrf.mpipomtc.WRFCoupledPOM.pominit | ( | self | ) |
Returns the POMInit object for this coupled forecast.
Definition at line 406 of file mpipomtc.py.
def hwrf.mpipomtc.WRFCoupledPOM.remove_ocean | ( | self | ) |
Removes the ocean component from coupling.
Definition at line 400 of file mpipomtc.py.