mpas_analysis.ocean.ClimatologyMapFluxes

class mpas_analysis.ocean.ClimatologyMapFluxes(config, mpasClimatologyTask, controlConfig=None, fluxType='mass')[source]

An analysis task for plotting sea surface fluxes. Observational comparison is not supported because no observational datasets are currently available.

__init__(config, mpasClimatologyTask, controlConfig=None, fluxType='mass')[source]

Construct the analysis task.

Parameters:
  • config (mpas_tools.config.MpasConfigParser) – Configuration options

  • mpasClimatologyTask (MpasClimatologyTask) – The task that produced the climatology to be remapped and plotted

  • controlconfig (mpas_tools.config.MpasConfigParser, optional) – Configuration options for a control run (if any)

  • fluxType (str, optional) – The type of surface fluxes, which corresponds to a different config section. One of ‘mass’ or ‘heat’.

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.

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()

Perform steps to set up the analysis (e.g. reading namelists and streams files).

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.