Target Plots

Target Plots#

Hydrological_model_validator.Plotting.Target_plots.comprehensive_target_diagram(data_dict: dict, **kwargs) → None[source]#

Generate a comprehensive yearly target diagram using normalized statistics (bias, CRMSD, RMSD).

Parameters:

  • data_dict (dict) – Dictionary of model and reference time series indexed by datetime

  • **kwargs –

    Additional keyword arguments include:

    output_pathstr or Path

    Required. Directory where the figure is saved.

    variable_namestr

    Short name used to infer full variable name and unit.

    variablestr

    Full variable name (e.g., “Chlorophyll”).

    unitstr

    Unit of measurement (e.g., “mg Chl/m³”).

    filenamestr

    Name of the output image file.

    titlestr

    Custom title for the plot.

    zone_boundstuple of float

    Tuple of two floats defining zone radii (e.g., (0.5, 0.7)).

    marker_shapeslist

    List of marker shapes for the data points.

    base_*various

    Options for the base target diagram (prefix: “base_”).

    overlay_*various

    Options for the overlay circles (prefix: “overlay_”).

    data_*various

    Options for the data point markers (prefix: “data_”).

    (no prefix)various

    General plot options (e.g., figsize, dpi, title_pad).

Raises:

ValueError – If required variable info or output path is missing.

Examples

>>> comprehensive_target_diagram(
...     data_dict,
...     variable_name="Chl",
...     output_path="./plots",
...     base_alpha=0.3,
...     overlay_circles=[0.5, 1.0, 1.5],
...     data_markersize=16,
...     title="Target Plot"
... )
Hydrological_model_validator.Plotting.Target_plots.target_diagram_by_month(data_dict: dict, **kwargs) → None[source]#

Generate a monthly target diagram with normalized statistics (bias, CRMSD, RMSD).

Parameters:

  • data_dict (dict) – Dictionary of model and reference monthly time series by year.

  • **kwargs –

    Additional keyword arguments include:

    output_pathstr or Path

    Required. Directory where the figure is saved.

    variable_namestr

    Short name used to infer full variable name and unit.

    variablestr

    Full variable name (e.g., “Chlorophyll”).

    unitstr

    Unit of measurement (e.g., “mg Chl/m³”).

    filenamestr

    Name of the output image file.

    titlestr

    Custom title for the plot.

    zone_boundstuple

    Tuple of two floats defining zone radii (e.g., (0.5, 0.7)).

    markerslist

    List of marker shapes per year.

    month_colorslist

    List of colors corresponding to each month.

    base_*various

    Options for the base diagram (prefix: “base_”).

    overlay_*various

    Options for the overlay diagram (prefix: “overlay_”).

    data_*various

    Options for data point markers (prefix: “data_”).

    (no prefix)various

    General plot options (e.g., figsize, dpi, fontsize).

Raises:

ValueError – If required variable info or output path is missing.

Examples

>>> target_diagram_by_month(
...     data_dict,
...     variable_name="Chl",
...     output_path="./monthly_plots",
...     data_markersize=16,
...     title="Monthly Target Diagram"
... )
Contents