wrfhydropy.Simulation

class wrfhydropy.Simulation

Class for a WRF-Hydro Simulation object. The Simulation object is used to orchestrate a WRF-Hydro simulation by accessing methods of Model, Domain, and Job objects. Optionally, a scheduler can also be added.

Methods

add(obj)	Add an approparite object to a Simulation, such as a Model, Domain, Job, or Scheduler
collect([sim_dir, output])	Collect simulation output after a run
compose([symlink_domain, force, check_nlst_warn])	Compose simulation directories and files :Parameters: * symlink_domain -- Symlink the domain files rather than copy * force -- Compose into directory even if not empty. This is considered bad practice but * is necessary in certain circumstances. * check_nlst_warn -- Allow the namelist checking/validation to only result in warnings. * This is also not great practice, but necessary in certain circumstances..
pickle(path)	Pickle sim object to specified file path :Parameters: path -- The file path for pickle
run([env])	Run the composed simulation.

pickle_sub_objs
restore_sub_objs

__init__()

Instantiates a Simulation object

Methods

__init__()	Instantiates a Simulation object
add(obj)	Add an approparite object to a Simulation, such as a Model, Domain, Job, or Scheduler
collect([sim_dir, output])	Collect simulation output after a run
compose([symlink_domain, force, check_nlst_warn])	Compose simulation directories and files :Parameters: * symlink_domain -- Symlink the domain files rather than copy * force -- Compose into directory even if not empty. This is considered bad practice but * is necessary in certain circumstances. * check_nlst_warn -- Allow the namelist checking/validation to only result in warnings. * This is also not great practice, but necessary in certain circumstances..
pickle(path)	Pickle sim object to specified file path :Parameters: path -- The file path for pickle
pickle_sub_objs([obj_list])
restore_sub_objs([obj_list])
run([env])	Run the composed simulation.

Attributes

model	A Model object
domain	A Domain object
jobs	a list containing Job objects
scheduler	A scheduler object to use for each Job in self.jobs
output	A CompletedSim object returned by the self.collect() method
base_hydro_namelist	base hydro namelist produced from model and domain
base_hrldas_namelist	base hrldas namelist produced from model and domain