pastas.plotting.plots.compare#
- pastas.plotting.plots.compare(models: list[pastas.typing.Model], names: list[str] | None = None, adjust_height: bool = True, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, **kwargs) dict[str, pastas.typing.Axes]#
Plot multiple Pastas models in one figure to visually compare models.
Notes
The models must have the same stressmodel names, otherwise the contributions will not be plotted, and parameters table will not display nicely.
- Parameters:
models (list) – List of pastas Models, works for N models, but certain things might not display nicely if the list gets too long.
names (list of str) – override model names by passing a list of names
adjust_height (bool, optional) – Adjust the height of the graphs, so that the vertical scale of all the subplots on the left is equal. Default is False, in which case the axes are not rescaled to include all data, so certain data might not be visible. Set False to ensure you can see all data.
tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start date for the simulation period (E.g. ‘1980-01-01 00:00:00’). If none is provided, the tmin from the oseries is used.
tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the end date for the simulation period (E.g. ‘2020-01-01 00:00:00’). If none is provided, the tmax from the oseries is used.
**kwargs – The kwargs are passed to the CompareModels.plot() function.
- Return type: