polaris.ocean.analysis_plots.plot_global_stats

polaris.ocean.analysis_plots.plot_global_stats(time, stats, field_name, out_filename, x_label='Days', title=None)[source]

Plot a time series of the global statistics of one field

Two panels share a time axis: the statistics themselves, with a standard-deviation envelope around the mean, and the change in each statistic since the beginning of the time series, which is where drift shows up.

Parameters:

  • time (numpy.ndarray) – The time axis of the series

  • stats (dict of str to numpy.ndarray) – The statistics to plot, keyed by 'min', 'max', 'mean' and 'std'. Any subset may be given and a statistic that is absent is omitted from the plot. The envelope is drawn only when both 'mean' and 'std' are present.

  • field_name (str) – The name of the field, used to label the vertical axes

  • out_filename (str) – The image file to write

  • x_label (str, optional) – The label for the time axis

  • title (str, optional) – A title for the figure