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, refConfig=None, subtaskSuffix=None)[source]¶ An analysis task for plotting 2D model fields against observations or a reference run.
Attributes: - hemisphere : str
The hemisphere to plot
- season : str
A season (key in
shared.constants.monthDictionary
) to be plotted.- comparisonGridName : {‘latlon’, ‘antarctic’}
The name of the comparison grid to plot.
- remapMpasClimatologySubtask :
RemapMpasClimatologySubtask
The subtask for remapping the MPAS climatology that this subtask will plot
- remapObsClimatologySubtask :
RemapObservedClimatologySubtask
The subtask for remapping the observational climatology that this subtask will plot
- refConfig :
MpasAnalysisConfigParser
Configuration options for a reference run (if any)
- outFileLabel : str
The prefix on each plot and associated XML file
- fieldNameInTitle : str
The name of the field being plotted, as used in the plot title
- mpasFieldName : str
The name of the variable in the MPAS timeSeriesStatsMonthly output
- refFieldName : str
The name of the variable to use from the observations or reference file
- refTitleLabel : str
the title of the observations or reference run subplot
- diffTitleLabel : str
the title of the difference (e.g. bias) subplot
- unitsLabel : str
the units of the plotted field, to be displayed on color bars
- imageCaption : str
the caption when mousing over the plot or displaying it full screen
- galleryGroup : str
the name of the group of galleries in which this plot belongs
- groupSubtitle : str
the subtitle of the group in which this plot belongs (or blank if none)
- groupLink : str
a short name (with no spaces) for the link to the gallery group
- galleryName : str
the name of the gallery in which this plot belongs
-
__init__
(parentTask, hemisphere, season, comparisonGridName, remapMpasClimatologySubtask, remapObsClimatologySubtask=None, refConfig=None, subtaskSuffix=None)[source]¶ Construct one analysis subtask for each plot (i.e. each season and comparison grid) and a subtask for computing climatologies.
Parameters: - parentTask :
AnalysisTask
The parent (master) task for this subtask
- hemisphere : str
The hemisphere to plot
- season : str
A season (key in
shared.constants.monthDictionary
) to be plotted.- comparisonGridName : {‘latlon’}
The name of the comparison grid to plot.
- remapMpasClimatologySubtask :
RemapMpasClimatologySubtask
The subtask for remapping the MPAS climatology that this subtask will plot
- remapObsClimatologySubtask :
RemapObservedClimatologySubtask
, optional The subtask for remapping the observational climatology that this subtask will plot
- refConfig :
MpasAnalysisConfigParser
, optional Configuration options for a reference run (if any)
- subtaskSuffix : str, optional
A suffix on the subtask to ensure that it is unique (e.g. the observations being plotted)
- parentTask :
Methods
__init__
(parentTask, hemisphere, season, …)Construct one analysis subtask for each plot (i.e. add_subtask
(subtask)Add a subtask to this tasks. check_analysis_enabled
(analysisOptionName[, …])Check to make sure a given analysis is turned on, issuing a warning or raising an exception if not. check_generate
()Determines if this analysis should be generated, based on the generate
config option andtaskName
,componentName
andtags
.is_alive
()Return whether process is alive join
([timeout])Wait until child process terminates run
([writeLogFile])Sets up logging and then runs the analysis task. run_after
(task)Only run this task after the given task has completed. run_task
()Performs analysis of sea-ice properties by comparing with previous model results and/or observations. set_plot_info
(outFileLabel, …[, maskValue])Store attributes related to plots, plot file names and HTML output. set_start_end_date
(section)Set the start and end dates in the config
correspond to the start and end years in a given category of analysissetup_and_check
()Perform steps to set up the analysis and check for errors in the setup. start
()Start child process terminate
()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.