mpas_analysis.ocean.ClimatologyMapOHCAnomaly¶

class mpas_analysis.ocean.ClimatologyMapOHCAnomaly(config, mpas_climatology_task, ref_year_climatology_task, control_config=None)[source]¶

An analysis task for comparison of the anomaly from a reference year (typically the start of the simulation) of ocean heat content (OHC)

Variables:

mpas_climatology_task (mpas_analysis.shared.climatology.MpasClimatologyTask) – The task that produced the climatology to be remapped and plotted
ref_year_climatology_task (mpas_analysis.shared.climatology.RefYearMpasClimatologyTask) – The task that produced the climatology from the first year to be remapped and then subtracted from the main climatology

__init__(config, mpas_climatology_task, ref_year_climatology_task, control_config=None)[source]¶

Construct the analysis task.

Parameters:

config (mpas_tools.config.MpasConfigParser) – Configuration options
mpas_climatology_task (mpas_analysis.shared.climatology.MpasClimatologyTask) – The task that produced the climatology to be remapped and plotted
ref_year_climatology_task (mpas_analysis.shared.climatology.RefYearMpasClimatologyTask) – The task that produced the climatology from the first year to be remapped and then subtracted from the main climatology
control_config (mpas_tools.config.MpasConfigParser, optional) – Configuration options for a control run (if any)

Methods

`__init__`(config, mpas_climatology_task, ...)	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`()	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`()	Checks whether analysis is being performed only on the reference year, in which case the analysis will not be meaningful.
`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.