mpas_analysis.ocean.plot_hovmoller_subtask.PlotHovmollerSubtask

class mpas_analysis.ocean.plot_hovmoller_subtask.PlotHovmollerSubtask(parentTask, regionName, inFileName, outFileLabel, fieldNameInTitle, mpasFieldName, unitsLabel, sectionName, thumbnailSuffix, imageCaption, galleryGroup, groupSubtitle, groupLink, galleryName, subtaskName=None)

Plots a time series vs. depth

Attributes

regionNamestr

The name of the region to plot

inFileNamestr

The file containing the time-depth data set to plot

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

unitsLabelstr

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

sectionNamestr

A section in the config file where the colormap and contour values are defined

thumbnailSuffixstr

The text to be displayed under the thumbnail image, to which the region name will be prepended

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, regionName, inFileName, outFileLabel, fieldNameInTitle, mpasFieldName, unitsLabel, sectionName, thumbnailSuffix, imageCaption, galleryGroup, groupSubtitle, groupLink, galleryName, subtaskName=None)

Construct the analysis task.

Parameters

parentTaskAnalysisTask

The parent task of which this is a subtask

regionNamestr

The name of the region to plot

inFileNamestr

The file containing the time-depth data set to plot

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

unitsLabelstr

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

sectionNamestr

a section in the config file where the colormap and contour values are defined

thumbnailSuffixstr

The text to be displayed under the thumbnail image, to which the region name will be prepended

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

subtaskNamestr

The name of the subtask (plotHovmoller<RegionName> by default)

Methods

__init__(self, parentTask, regionName, …)	Construct the analysis task.
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)	Make the Hovmoller plot from the time series.
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.