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, controlConfig=None, regionMaskFile=None)[source]

Plots a time series vs. depth

Variables:

  • controlconfig (mpas_tools.config.MpasConfigParser) – Configuration options for a control run (if any)

  • regionName (str) – The name of the region to plot

  • inFileName (str) – The file containing the time-depth data set to plot

  • 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

  • unitsLabel (str) – The units of the plotted field, to be displayed on color bars

  • sectionName (str) – A section in the config file where the colormap and contour values are defined

  • regionMaskFile (str) – A geojson file with regions (including one corresponding to regionName) that will be used to make an inset

  • thumbnailSuffix (str) – The text to be displayed under the thumbnail image, to which the region name will be prepended

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

Construct the analysis task.

Parameters:

  • parentTask (AnalysisTask) – The parent task of which this is a subtask

  • regionName (str) – The name of the region to plot

  • inFileName (str) – The file containing the time-depth data set to plot

  • 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

  • unitsLabel (str) – the units of the plotted field, to be displayed on color bars

  • sectionName (str) – a section in the config file where the colormap and contour values are defined

  • thumbnailSuffix (str) – The text to be displayed under the thumbnail image, to which the region name will be prepended

  • 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

  • subtaskName (str, optional) – The name of the subtask (plotHovmoller<RegionName> by default)

  • controlconfig (mpas_tools.config.MpasConfigParser, optional) – Configuration options for a control run (if any)

  • regionMaskFile (str, optional) – A geojson file with regions (including one corresponding to regionName) that will be used to make an inset

Methods

__init__(parentTask, regionName, inFileName, ...)

Construct the analysis task.

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 and taskName, componentName and tags.

close()

Close the Process object.

is_alive()

Return whether process is alive

join([timeout])

Wait until child process terminates

kill()

Terminate process; sends SIGKILL signal or uses TerminateProcess()

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()

Make the Hovmoller plot from the time series.

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 analysis

setup_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.