mpas_analysis.ocean.ClimatologyMapMLD

class mpas_analysis.ocean.ClimatologyMapMLD(config, mpasClimatologyTask, refConfig=None)

An analysis task for comparison of mixed layer depth (mld) against observations

__init__(config, mpasClimatologyTask, refConfig=None)

Construct the analysis task.

Parameters:

config : MpasAnalysisConfigParser

Configuration options

mpasClimatologyTask : MpasClimatologyTask

The task that produced the climatology to be remapped and plotted

refConfig : MpasAnalysisConfigParser, optional

Configuration options for a reference run (if any)

Methods

__init__(config, mpasClimatologyTask[, …])	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.
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()	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()	Check if MLD capability was turned on in the run.
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.