wrfhydropy.EnsembleSimulation

class wrfhydropy.EnsembleSimulation(ncores: int = 1)

Class for a WRF-Hydro EnsembleSimulation object. The Ensemble Simulation object is used to orchestrate a set of ‘N’ WRF-Hydro simulations. It requires members with pre-compiled models and there are set and get methods across the ensemble (member_diffs & set_member_diffs). Jobs and scheduler set on the EnsembleSimulation object are set on all the members.

Attributes:

N

member_diffs

Get method for ensemble member differences.

Methods

add(self, obj, …)	Add an approparite object to an EnsembleSimulation, such as a Simulation, Job, or Scheduler.
compose(self, symlink_domain, force, …)	Ensemble 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 ensemble sim object to specified file path :Parameters: path – The file path for pickle
replicate_member(self, N, copy_members)
restore_members(self, ens_dir, recursive)	Restore members from disk, replace paths with the loaded pickle.
rm_members(self)	Remove members from memory, replace with their paths.
run(self, n_concurrent, teams, …)	Run the ensemble of simulations.
set_member_diffs(self, att_tuple, values)	Set method for ensemble member differences.

collect

__init__(self, ncores:int=1)

Instantiates an EnsembleSimulation object.

Methods

__init__(self, ncores)	Instantiates an EnsembleSimulation object.
add(self, obj, …)	Add an approparite object to an EnsembleSimulation, such as a Simulation, Job, or Scheduler.
collect(self[, output])
compose(self, symlink_domain, force, …)	Ensemble 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 ensemble sim object to specified file path :Parameters: path – The file path for pickle
replicate_member(self, N, copy_members)
restore_members(self, ens_dir, recursive)	Restore members from disk, replace paths with the loaded pickle.
rm_members(self)	Remove members from memory, replace with their paths.
run(self, n_concurrent, teams, …)	Run the ensemble of simulations.
set_member_diffs(self, att_tuple, values)	Set method for ensemble member differences.

Attributes

N
member_diffs	Get method for ensemble member differences.