mpas_analysis.shared.climatology.RemapObservedClimatologySubtask

class mpas_analysis.shared.climatology.RemapObservedClimatologySubtask(parentTask, seasons, fileName, outFilePrefix, comparisonGridNames=['latlon'], subtaskName='remapObservations')

An analysis task for comparison of 2D model fields against observations.

Attributes

seasonslist of str

A list of seasons (keys in constants.monthDictionary) over which the climatology should be computed.

fileNamestr

The name of the observation file

outFilePrefixstr

The prefix in front of output files and mapping files, typically the name of the field being remapped

comparisonGridNameslist of {‘latlon’, ‘antarctic’, ‘arctic’}

The name(s) of the comparison grid to use for remapping.

__init__(self, parentTask, seasons, fileName, outFilePrefix, comparisonGridNames=['latlon'], subtaskName='remapObservations')

Construct one analysis subtask for each plot (i.e. each season and comparison grid) and a subtask for computing climatologies.

Parameters

parentTaskAnalysisTask

The parent (master) task for this subtask

seasonslist of str

A list of seasons (keys in constants.monthDictionary) over which the climatology should be computed.

fileNamestr

The name of the observation file

outFilePrefixstr

The prefix in front of output files and mapping files, typically the name of the field being remapped

comparisonGridNameslist of {‘latlon’, ‘antarctic’, ‘arctic’},

optional The name(s) of the comparison grid to use for remapping.

subtaskNamestr, optional

The name of the subtask

Methods

__init__(self, parentTask, seasons, …[, …])	Construct one analysis subtask for each plot (i.e.
add_subtask(self, subtask)	Add a subtask to this tasks.
build_observational_dataset(self, fileName)	read in the data sets for observations, and possibly rename some variables and dimensions.
check_analysis_enabled(self, analysisOptionName)	Check to make sure a given analysis is turned on, issuing a warning or raising an exception if not.
check_generate(self)	Determines if this analysis should be generated, based on the generate config option and taskName, componentName and tags.
close(self)	Close the Process object.
get_file_name(self, stage[, season, …])	Given config options, the name of a field and a string identifying the months in a seasonal climatology, returns the full path for MPAS climatology files before and after remapping.
get_observation_descriptor(self, fileName)	get a MeshDescriptor for the observation grid.
is_alive(self)	Return whether process is alive
join(self[, timeout])	Wait until child process terminates
kill(self)	Terminate process; sends SIGKILL signal or uses TerminateProcess()
run(self[, writeLogFile])	Sets up logging and then runs the analysis task.
run_after(self, task)	Only run this task after the given task has completed.
run_task(self)	Performs remapping of obsrevations to the comparsion grid
set_start_end_date(self, 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(self)	Perform steps to set up the analysis and check for errors in the setup.
start(self)	Start child process
terminate(self)	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.