rameau.core.Model.run_optimization

Model.run_optimization(maxit=None, starting_date=None, ending_date=None, method=None, transformation=None, river_objective_function=None, selected_watersheds=None, verbose=None)[source]

Start an optimisation run.

Parameters:

  • maxit (int, optional) – Number of iterations for the optimisation algorithm.

  • starting_date (datetime.datetime, optional) – The date and time defining the start of the period to consider in the input data for the optimisation run.

  • ending_date (datetime.datetime, optional) – The date and time defining the end of the period to consider in the input data for the optimisation run.

  • method (str, optional) – The approach to use when several gauged watersheds need to be considered in the optimisation run. See OptimizationSettings.method for details.

  • transformation (str, optional) – The function to apply to transform the observed and predicted river flow (Q) before computing the objective function. See OptimizationSettings.transformation for details.

  • river_objective_function (str, optional) – The objective function to use to compare the observed and predicted river flow. See OptimizationSettings.river_objective_function for details.

  • selected_watersheds (list or int, optional) – The indices of the watersheds to consider in the optimisation run. The indices relate to those in the sequence of watersheds specified in the Tree. If not provided, all gauged watersheds are considered.

  • verbose (bool, optional) – Whether to display information for each step of the optimisation process. If not provided, no information is displayed.

Returns:

simulation.OptiSimulation