mpas_analysis.ocean.StreamfunctionMOC

class mpas_analysis.ocean.StreamfunctionMOC(config, mpasClimatologyTask, controlConfig=None)

Computation and plotting of model meridional overturning circulation. Will eventually support:

• MOC streamfunction, post-processed

• MOC streamfunction, from MOC analysis member

• MOC time series (max value at 24.5N), post-processed

• MOC time series (max value at 24.5N), from MOC analysis member

__init__(self, config, mpasClimatologyTask, controlConfig=None)

Construct the analysis task.

Parameters

configinstance of MpasAnalysisConfigParser

Contains configuration options

mpasClimatologyTaskMpasClimatologyTask

The task that produced the climatology to be remapped and plotted

controlConfigMpasAnalysisConfigParser, optional

Configuration options for a control run (if any)

Methods

__init__(self, config, mpasClimatologyTask)	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)	Run the analysis.
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 (e.g.
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.