mpas_analysis.sea_ice.plot_climatology_map_subtask.PlotClimatologyMapSubtask

class mpas_analysis.sea_ice.plot_climatology_map_subtask.PlotClimatologyMapSubtask(parentTask, hemisphere, season, comparisonGridName, remapMpasClimatologySubtask, remapObsClimatologySubtask=None, controlConfig=None, subtaskSuffix=None)

An analysis task for plotting 2D model fields against observations or a control run.

Attributes

hemispherestr

The hemisphere to plot

seasonstr

A season (key in shared.constants.monthDictionary) to be plotted.

comparisonGridName{‘latlon’, ‘antarctic’}

The name of the comparison grid to plot.

remapMpasClimatologySubtaskRemapMpasClimatologySubtask

The subtask for remapping the MPAS climatology that this subtask will plot

remapObsClimatologySubtaskRemapObservedClimatologySubtask

The subtask for remapping the observational climatology that this subtask will plot

controlConfigMpasAnalysisConfigParser

Configuration options for a control run (if any)

outFileLabelstr

The prefix on each plot and associated XML file

fieldNameInTitlestr

The name of the field being plotted, as used in the plot title

mpasFieldNamestr

The name of the variable in the MPAS timeSeriesStatsMonthly output

refFieldNamestr

The name of the variable to use from the observations or reference file

refTitleLabelstr

the title of the observations or control run subplot

diffTitleLabelstr

the title of the difference (e.g. bias) subplot

unitsLabelstr

the units of the plotted field, to be displayed on color bars

imageCaptionstr

the caption when mousing over the plot or displaying it full screen

galleryGroupstr

the name of the group of galleries in which this plot belongs

groupSubtitlestr

the subtitle of the group in which this plot belongs (or blank if none)

groupLinkstr

a short name (with no spaces) for the link to the gallery group

galleryNamestr

the name of the gallery in which this plot belongs

__init__(self, parentTask, hemisphere, season, comparisonGridName, remapMpasClimatologySubtask, remapObsClimatologySubtask=None, controlConfig=None, subtaskSuffix=None)

Construct one analysis subtask for each plot (i.e. each season and comparison grid) and a subtask for computing climatologies.

Parameters

parentTaskAnalysisTask

The parent (master) task for this subtask

hemispherestr

The hemisphere to plot

seasonstr

A season (key in shared.constants.monthDictionary) to be plotted.

comparisonGridName{‘latlon’}

The name of the comparison grid to plot.

remapMpasClimatologySubtaskRemapMpasClimatologySubtask

The subtask for remapping the MPAS climatology that this subtask will plot

remapObsClimatologySubtaskRemapObservedClimatologySubtask, optional

The subtask for remapping the observational climatology that this subtask will plot

controlConfigMpasAnalysisConfigParser, optional

Configuration options for a control run (if any)

subtaskSuffixstr, optional

A suffix on the subtask to ensure that it is unique (e.g. the observations being plotted)

Methods

__init__(self, parentTask, hemisphere, …)	Construct one analysis subtask for each plot (i.e.
add_subtask(self, subtask)	Add a subtask to this tasks.
check_analysis_enabled(self, analysisOptionName)	Check to make sure a given analysis is turned on, issuing a warning or raising an exception if not.
check_generate(self)	Determines if this analysis should be generated, based on the generate config option and taskName, componentName and tags.
close(self)	Close the Process object.
is_alive(self)	Return whether process is alive
join(self[, timeout])	Wait until child process terminates
kill(self)	Terminate process; sends SIGKILL signal or uses TerminateProcess()
run(self[, writeLogFile])	Sets up logging and then runs the analysis task.
run_after(self, task)	Only run this task after the given task has completed.
run_task(self)	Performs analysis of sea-ice properties by comparing with previous model results and/or observations.
set_plot_info(self, outFileLabel, …[, …])	Store attributes related to plots, plot file names and HTML output.
set_start_end_date(self, section)	Set the start and end dates in the config correspond to the start and end years in a given category of analysis
setup_and_check(self)	Perform steps to set up the analysis and check for errors in the setup.
start(self)	Start child process
terminate(self)	Terminate process; sends SIGTERM signal or uses TerminateProcess()

Attributes

BLOCKED
FAIL
READY
RUNNING
SUCCESS
UNSET
authkey
daemon	Return whether process is a daemon
exitcode	Return exit code of process or None if it has yet to stop
ident	Return identifier (PID) of process or None if it has yet to start
name
pid	Return identifier (PID) of process or None if it has yet to start
sentinel	Return a file descriptor (Unix) or handle (Windows) suitable for waiting for process termination.