Model

Constructor

Model(setup, mesh)	Primary data structure of the hydrological model smash.
Model.copy()	Create a deep copy of Model.

Attributes

Model.setup	Model setup.
Model.mesh	Model mesh.
Model.response_data	Model response data.
Model.u_response_data	Model response data uncertainties.
Model.physio_data	Model physiographic data.
Model.atmos_data	Model atmospheric data.
Model.rr_parameters	Model rainfall-runoff parameters.
Model.rr_initial_states	Model rainfall-runoff initial states.
Model.serr_mu_parameters	Model structural error mu parameters.
Model.serr_sigma_parameters	Model structural error sigma parameters.
Model.nn_parameters	The weight and bias of the parameterization neural network.
Model.response	Model response.
Model.rr_final_states	Model rainfall-runoff final states.

Simulation

Model.forward_run([cost_options, ...])	Run the forward Model.
Model.optimize([mapping, optimizer, ...])	Model assimilation using numerical optimization algorithms.
Model.multiset_estimate(multiset[, alpha, ...])	Model assimilation using Bayesian-like estimation on multiple sets of solutions.
Model.bayesian_optimize([mapping, ...])	Model bayesian assimilation using numerical optimization algorithms.

Parameters/States/Control

Model.get_rr_parameters(key)	Get the values of a Model rainfall-runoff parameter.
Model.get_rr_initial_states(key)	Get the values of a Model rainfall-runoff initial state.
Model.get_serr_mu_parameters(key)	Get the values of a Model structural error mu parameter.
Model.get_serr_sigma_parameters(key)	Get the values of a Model structural error sigma parameter.
Model.get_rr_final_states(key)	Get the values of a Model rainfall-runoff final state.
Model.set_rr_parameters(key, value)	Set the values of a Model rainfall-runoff parameter.
Model.set_rr_initial_states(key, value)	Set the values of a Model rainfall-runoff initial state.
Model.set_serr_mu_parameters(key, value)	Set the values of a Model structural error mu parameter.
Model.set_serr_sigma_parameters(key, value)	Set the values of a Model structural error sigma parameter.
Model.set_control_optimize(control_vector[, ...])	Retrieve the Model parameters/states from the optimization control vector.
Model.set_control_bayesian_optimize(...[, ...])	Retrieve the Model parameters/states from the bayesian optimization control vector.
Model.get_rr_parameters_bounds()	Get the boundary condition for the Model rainfall-runoff parameters.
Model.get_rr_initial_states_bounds()	Get the boundary condition for the Model rainfall-runoff initial states.
Model.get_serr_mu_parameters_bounds()	Get the boundary condition for the Model structural error mu parameters.
Model.get_serr_sigma_parameters_bounds()	Get the boundary condition for the Model structural error sigma parameters.
Model.get_serr_mu()	Get the structural error mu value by applying the mu mapping.
Model.get_serr_sigma()	Get the structural error sigma value by applying the sigma mapping.
Model.get_nn_parameters_weight()	Get the weight of the parameterization neural network.
Model.get_nn_parameters_bias()	Get the bias of the parameterization neural network.
Model.set_nn_parameters_weight([value, ...])	Set the values of the weight in the parameterization neural network.
Model.set_nn_parameters_bias([value, ...])	Set the values of the bias in the parameterization neural network.
Model.adjust_interception([active_cell_only])	Adjust the interception reservoir capacity.