pastas.plotting.modelplots.Plotting.summary_pdf#

pastas.plotting.modelplots.Plotting.summary_pdf(tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, results_kwargs: dict | None = None, diagnostics_kwargs: dict | None = None, fname: str | None = None, dpi: int = 150) → pastas.typing.Figure#

Create a PDF file (A4) with the results and diagnostics plot.

Parameters:

  • tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start date for the period (E.g. ‘1980-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.

  • tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the end date for the period (E.g. ‘2020-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.

  • results_kwargs (dict, optional) – dictionary passed on to ml.plots.results method.

  • diagnostics_kwargs (dict, optional) – dictionary passed on to ml.plots.diagnostics method.

  • fname (str, optional) – string with the file name / path to store the PDF file.

  • dpi (int, optional) – dpi to save the figure with.

Returns:

fig

Return type:

matplotlib.pyplot.Figure instance