pastas.plotting.modelcompare.CompareModels.get_metrics

pastas.plotting.modelcompare.CompareModels.get_metrics(models: list[pastas.typing.Model] | None = None, metric_selection: list[str] | None = None) → pandas.DataFrame

get metrics of all models in a DataFrame.

Parameters:

• models (list of ps.Model, optional) – list of models to calculate metrics for, by default None.

• metric_selection (list of str, optional) – names of metrics to calculate, by default None.

Returns:

metrics – DataFrame containing calculated metrics.

Return type:

pd.DataFrame