mpas_analysis.shared.climatology.RemapObservedClimatologySubtask¶
-
class
mpas_analysis.shared.climatology.
RemapObservedClimatologySubtask
(parentTask, seasons, fileName, outFilePrefix, comparisonGridNames=['latlon'], subtaskName='remapObservations')[source]¶ An analysis task for comparison of 2D model fields against observations.
- Variables
seasons (list of str) – A list of seasons (keys in
constants.monthDictionary
) over which the climatology should be computed.fileName (str) – The name of the observation file
outFilePrefix (str) – The prefix in front of output files and mapping files, typically the name of the field being remapped
comparisonGridNames (list of {'latlon', 'antarctic', 'arctic'}) – The name(s) of the comparison grid to use for remapping.
-
__init__
(parentTask, seasons, fileName, outFilePrefix, comparisonGridNames=['latlon'], subtaskName='remapObservations')[source]¶ Construct one analysis subtask for each plot (i.e. each season and comparison grid) and a subtask for computing climatologies.
- Parameters
parentTask (
AnalysisTask
) – The parent (master) task for this subtaskseasons (list of str) – A list of seasons (keys in
constants.monthDictionary
) over which the climatology should be computed.fileName (str) – The name of the observation file
outFilePrefix (str) – The prefix in front of output files and mapping files, typically the name of the field being remapped
comparisonGridNames (list of {'latlon', 'antarctic', 'arctic'},) – optional The name(s) of the comparison grid to use for remapping.
subtaskName (str, optional) – The name of the subtask
Methods
__init__
(parentTask, seasons, fileName, …)Construct one analysis subtask for each plot (i.e.
add_subtask
(subtask)Add a subtask to this tasks.
build_observational_dataset
(fileName)read in the data sets for observations, and possibly rename some variables and dimensions.
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
.close
()Close the Process object.
get_file_name
(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
(fileName)get a MeshDescriptor for the observation grid.
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
()Performs remapping of obsrevations to the comparsion grid
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 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.