mpas_analysis.ocean.OceanRegionalProfiles

class mpas_analysis.ocean.OceanRegionalProfiles(config, regionMasksTask, controlConfig=None)

Compute and plot vertical profiles of regionally analyzed data. The mean and standard deviation of the data are computed over each region. The mean and std. dev. are computed in time (within the requested seasons) and this result is plotted as a vertical profile with shading showing variability.

__init__(config, regionMasksTask, controlConfig=None)

Construct the analysis task.

Parameters:

• config (mpas_tools.config.MpasConfigParser) – Contains configuration options

• regionMasksTask (ComputeRegionMasks) – A task for computing region masks

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

Methods

__init__(config, regionMasksTask[, ...])	Construct the analysis task.
add_region_group(regionMasksTask, ...[, ...])	Add years to the profiles to compute
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()	Run the analysis.
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 (e.g. reading namelists and streams files).
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.