rameau.core.Model.run_simulation

Model.run_simulation(name=None, starting_date=None, ending_date=None, spinup_settings=None)[source]

Start a simulation run.

Parameters:

  • name (str, optional) – Name of the simulation. This name is used to name to the output directory. If omitted, default is “simulation”.

  • starting_date (datetime.datetime, optional) – Starting date of the simulation. This date needs to be contained in the rainfall input data. If None, default is the starting date of the rainfall input data. The simulation run will start from this date and will stop at the end of the meteorological input data or at the simulation ending date.

  • ending_date (datetime.datetime, optional) – Ending date of the simulation. This date needs to be contained in the rainfall input data. If None, default is the ending date of the rainfall input data.

  • spinup_settings (dict or SpinupSettings, optional) – Spinup settings of the simulation. See SpinupSettings for details.

Returns:

simulation.Simulation