mpas_analysis.ocean.ClimatologyMapSoseTemperature¶
-
class
mpas_analysis.ocean.
ClimatologyMapSoseTemperature
(config, mpasClimatologyTask, refConfig=None)[source]¶ An analysis task for comparison of antarctic temperature against SOSE fields
-
__init__
(config, mpasClimatologyTask, refConfig=None)[source]¶ 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)
- config :
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 andtaskName
,componentName
andtags
.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 analysissetup_and_check
()Perform steps to set up the analysis (e.g. 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. -