mpas_analysis.shared.transects.compute_transect_masks_subtask.ComputeTransectMasksSubtask

class mpas_analysis.shared.transects.compute_transect_masks_subtask.ComputeTransectMasksSubtask(parentTask, transectGroup, subprocessCount=None)

An analysis tasks for computing cell masks for transects defined by geojson features

Variables

• ~ComputeTransectMasksSubtask.aggregationFunction (callable) – An aggregation function returned by geometric_features.aggregation.get_region_by_name()

• ~ComputeTransectMasksSubtask.geojsonFileName (str) – A geojson file, typically from the MPAS geometric_features repository, defining the shapes to be masked

• ~ComputeTransectMasksSubtask.outFileSuffix (str) – The suffix for the resulting mask file

• ~ComputeTransectMasksSubtask.maskFileName (str) – The name of the output mask file

__init__(parentTask, transectGroup, subprocessCount=None)

Construct the analysis task and adds it as a subtask of the parentTask.

Parameters

• parentTask (AnalysisTask) – The parent task, used to get the taskName, config and componentName

• transectGroup (str) – The name of a transect group, see mpas_analysis.shared.transects.get_transect_info()

• subprocessCount (int, optional) – The number of processes that can be used to make the mask, default is as many processes as allowed

Methods

__init__(parentTask, transectGroup[, ...])	Construct the analysis task and adds it as a subtask of the parentTask.
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.
expand_transect_names(transectNames)	If transectNames contains 'all', make sure the geojson file exists and then return all the transect names found in the file.
is_alive()	Return whether process is alive
join([timeout])	Wait until child process terminates
kill()	Terminate process; sends SIGKILL signal or uses TerminateProcess()
make_transect_mask()	If the geojson mask file has not already been cached in the diagnostics or custom diagnostic directories, it will be created in the analysis output's masks directory.
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()	Compute the requested climatologies
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 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.