Model

Constructor

Model(setup, mesh)

Primary data structure of the hydrological model smash.

Attributes

Model.setup	The setup of the Model.
Model.mesh	The mesh of the Model.
Model.input_data	The input data of the Model.
Model.parameters	The parameters of the Model.
Model.states	The states of the Model.
Model.output	The output of the Model.

Simulation

Model.run([inplace])	Run the Model.
Model.multiple_run(sample[, jobs_fun, ...])	Compute Multiple Run of Model.
Model.optimize([mapping, algorithm, ...])	Optimize the Model.

Model.bayes_estimate([sample, alpha, n, ...])	Estimate prior Model parameters/states using Bayesian approach.
Model.bayes_optimize([sample, alpha, n, ...])	Optimize the Model using Bayesian approach.
Model.ann_optimize([net, optimizer, ...])	Optimize the Model using Artificial Neural Network.

Event segmentation

Model.event_segmentation([peak_quant, ...])

Compute segmentation information of flood events over all catchments of the Model.

Signatures

Model.signatures([sign, obs_comp, event_seg])	Compute continuous or/and flood event signatures of the Model.
Model.signatures_sensitivity([problem, n, ...])	Compute the first- and total-order variance-based sensitivity (Sobol indices) of spatially uniform hydrological model parameters on the output signatures.

Precipitation indices

Model.prcp_indices()

Compute precipitations indices of the Model.

Others

Model.copy()	Make a deepcopy of the Model.
Model.get_bound_constraints([states])	Get the boundary constraints of the Model parameters/states.