ForecastSettings

class rameau.core.ForecastSettings(emission_date=None, scope=datetime.timedelta(days=1), year_members=None, correction='no', pumping_date=None, quantiles_output=False, quantiles=[10, 20, 50, 80, 90], norain=False)[source]

Forecast settings.

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 ìnt, 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 the forecast.

correction	description
`'no'`	No correction is performed. This is the default behaviour.
`'halflife'`	A correction using the observation of the forecast variable on the issue date is applied and then the correction is gradually dampened overtime based on a half-life parameter.

pumping_date (datetime.datetime, optional) – The date and time on which to start pumping.
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:

ForecastSettings

Attributes

`correction`	The approach to use to correct the initial conditionsbefore issuing a forecast.
`emission_date`	The date and time on which to issue a forecast.
`norain`	Whether to include an extra ensemble member corresponding toa completely rain-free year.
`pumping_date`	The date and time on which to start pumping.
`quantiles`	The climatology percentiles to include in the forecast ensemble members.
`quantiles_output`	Whether to reduce the forecast ensemble members to specific climatology quantiles.
`scope`	The duration for which to run the forecast.
`year_members`	The years to consider to form the forecast ensemble members.