mpas_analysis.ocean.IndexNino34¶

class mpas_analysis.ocean.IndexNino34(config, mpasTimeSeriesTask, refConfig=None)[source]¶

A task for computing and plotting time series and spectra of the El Nino 3.4 climate index

Attributes:	mpasTimeSeriesTask : `MpasTimeSeriesTask` The task that extracts the time series from MPAS monthly output refConfig : `MpasAnalysisConfigParser` Configuration options for a reference run (if any)

__init__(config, mpasTimeSeriesTask, refConfig=None)[source]¶

Construct the analysis task.

Parameters:	config : `MpasAnalysisConfigParser` Configuration options mpasTimeSeriesTask : `MpasTimeSeriesTask` The task that extracts the time series from MPAS monthly output refConfig : `MpasAnalysisConfigParser`, optional Configuration options for a reference run (if any)

Methods

`__init__`(config, mpasTimeSeriesTask[, refConfig])	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`()	Computes NINO34 index and plots the time series and power spectrum with 95 and 99% confidence bounds
`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.