rameau.core.simulation.ForecastSimulation.get_metrics
- ForecastSimulation.get_metrics(variable='riverflow', header_type='name', start_date=None, end_date=None, opti=False)
Get the metrics.
- Parameters:
variable (
str, optional) – The variable type for which metrics are computed. Possible values are ‘riverflow’ and ‘watertable’.header_type (
str, optional) – Whether to use the watershed identifiers or names as dataframe header.start_date (
datetime.datetime, optional) – Starting date of the temporal period over which metrics will be computed. If None, it is the simulation starting date. Default is None.end_date (
datetime.datetime, optional) – Ending date of the temporal period over which metrics will be computed. If None, it is the simulation ending date. Default is None.opti (
bool, optional) – Whether to retrieve metrics computed over the optimization period. If True,start_dateandend_datekeyword arguments will be ignored. Default to False.
- Returns: