Base class for monitoring diagnostics#

Base class for monitoring diagnostics.

Classes:

MonitorBase(config)

Base class for monitoring diagnostic.

class esmvaltool.diag_scripts.monitor.monitor_base.MonitorBase(config)[source]#

Base class for monitoring diagnostic.

It contains the common methods for path creation, provenance recording, option parsing and to create some common plots.

Methods:

`get_plot_folder`(var_info)	Get plot storage folder from variable info.
`get_plot_name`(plot_type, var_info[, add_ext])	Get plot filename from variable info.
`get_plot_path`(plot_type, var_info[, add_ext])	Get plot full path from variable info.
`get_provenance_record`(ancestor_files, **kwargs)	Create provenance record for the diagnostic data and plots.
`plot_cube`(cube, filename[, linestyle])	Plot a timeseries from a cube.
`plot_timeseries`(cube, var_info[, period])	Plot timeseries from a cube.
`record_plot_provenance`(filename, var_info, ...)	Write provenance info for a given file.

get_plot_folder(var_info)[source]#

Get plot storage folder from variable info.

get_plot_name(plot_type, var_info, add_ext=True)[source]#

Get plot filename from variable info.

Parameters:

plot_type (str) – Name of the plot
var_info (dict) – Variable information from ESMValTool
add_ext (bool, optional (default: True)) – Add filename extension from configuration file.

get_plot_path(plot_type, var_info, add_ext=True)[source]#

Get plot full path from variable info.

Parameters:

plot_type (str) – Name of the plot
var_info (dict) – Variable information from ESMValTool
add_ext (bool, optional (default: True)) – Add filename extension from configuration file.

static get_provenance_record(ancestor_files, **kwargs)[source]#: Create provenance record for the diagnostic data and plots.

plot_cube(cube, filename, linestyle='-', **kwargs)[source]#

Plot a timeseries from a cube.

Supports multiplot layouts for cubes with extra dimensions shape_id or region.

plot_timeseries(cube, var_info, period='', **kwargs)[source]#

Plot timeseries from a cube.

It also automatically smoothes it for long timeseries of monthly data:

Between 10 and 70 years long, it also plots the 12-month rolling average along the raw series
For more than ten years, it plots the 12-month and 10-years rolling averages and not the raw series

record_plot_provenance(filename, var_info, plot_type, **kwargs)[source]#: Write provenance info for a given file.