nwm_eval.create_plots.save_plot#

nwm_eval.create_plots.save_plot(plt, conf, data_paths, plt_type, plt_name=None, lead=None, ref_time=None, dataset=None, metric=None, location=None)[source]#

Save the plot to a file.

Return type:

Path

Parameters:
  • plt – The plot object to be saved.

  • conf – A dictionary containing the configuration, which may include a “tag” key.

  • data_paths – A dictionary containing the paths to the data files.

  • plt_type – The type of the plot.

  • plt_name – The name of the plot.

  • lead – The lead time for the plot.

  • ref_time – The reference time for the plot.

  • dataset – The dataset name for the plot.

  • metric – The metric name for the plot.

  • location – The location name for the plot.

Returns:

A Path object representing the saved plot file.