rameau.core.Model.run_forecast

Model.run_forecast(emission_date=None, scope=None, year_members=None, correction=None, pumping_date=None, quantiles_output=None, quantiles=None, norain=None)[source]

Start a forecast run.

Parameters:

emission_date (datetime.datetime, optional) – The date and time on which to issue a forecast.
scope (datetime.timedelta, optional) – The duration for which to run the forecast. If not provided, set to one day.
year_members (list or int, optional) – The years to consider to form the forecast ensemble members. If not provided, all years in record are considered.
correction (str, optional) – The approach to use to correct the initial conditions before issuing a forecast. See ForecastSettings for details.
pumping_date (datetime.datetime, optional)
quantiles_output (bool, optional) – Whether to reduce the forecast ensemble members to specific climatology quantiles. If not provided, all years in record or years specified via the year_members parameter are considered. The quantiles can be chosen via the quantiles parameter.
quantiles (list or int, optional) – The climatology percentiles to include in the forecast ensemble members. Only considered if quantiles_output is set to True. By default, the percentiles computed are 10, 20, 50, 80, and 90.
norain (bool, optional) – Whether to include an extra ensemble member corresponding to a completely rain-free year. By default, this member is not included in the forecast output.

Returns:

simulation.ForecastSimulation