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(self, obj, …)	Add an approparite object to a Simulation, such as a Model, Domain, Job, or Scheduler
collect(self[, sim_dir, output])	Collect simulation output after a run
compose(self, symlink_domain, force, …)	Compose simulation directories and files :Parameters: * symlink_domain – Symlink the domain files rather than copy * force – Compose into directory even if not empty.
pickle(self, path)	Pickle sim object to specified file path :Parameters: path – The file path for pickle
run(self, env)	Run the composed simulation.

pickle_sub_objs
restore_sub_objs

__init__(self)

Instantiates a Simulation object

Methods

__init__(self)	Instantiates a Simulation object
add(self, obj, …)	Add an approparite object to a Simulation, such as a Model, Domain, Job, or Scheduler
collect(self[, sim_dir, output])	Collect simulation output after a run
compose(self, symlink_domain, force, …)	Compose simulation directories and files :Parameters: * symlink_domain – Symlink the domain files rather than copy * force – Compose into directory even if not empty.
pickle(self, path)	Pickle sim object to specified file path :Parameters: path – The file path for pickle
pickle_sub_objs(self, obj_list, , ])
restore_sub_objs(self, obj_list, , ])
run(self, env)	Run the composed simulation.