polaris.tasks.e3sm.init.component_inputs.moc_masks.MocMasksStep

class polaris.tasks.e3sm.init.component_inputs.moc_masks.MocMasksStep(component, subdir, cull_mesh_step, mesh_name, name='moc_masks')[source]

A step for the MOC basin masks and southern-boundary transects that MPAS-Ocean reads at run time.

E3SM points two streams at this one file, regionalMasksInput and transectMasksInput, and two analysis members that are on by default read them: mocStreamfunction, which E3SM enables per mesh and has enabled for every mesh since EC30to60E2r2, and meridionalHeatTransport, which is enabled for every mesh. Without the file neither aborts – nRegions and nRegionGroups fall back to 1 and the MOC member logs that its region group was not found and carries on – so the failure is output computed against a meaningless region, with nothing to notice in a run. That is why this is a component input and not one of the analysis products in the follow-up work.

The masks come from the mesh component’s feature-mask step; the MOC filename and the southern-boundary transects come from polaris.tasks.mesh.spherical.feature_masks.moc, which the ocean feature-mask step uses too. Nothing here reaches for an ocean component, so an e3sm/init step can build these masks without an [ocean] config section.

Variables:

features_date (str) – The date stamp of the geometric_features aggregation the masks were built from, which is not the date the file was created.

__init__(component, subdir, cull_mesh_step, mesh_name, name='moc_masks')[source]

Create a new step.

Parameters:

Methods

__init__(component, subdir, cull_mesh_step, ...)

Create a new step.

add_cf_check([filename])

Check an output file for CF compliance after the step runs.

add_dependency(step[, name])

Add step as a dependency of this step (i.e. this step can't run until the dependency has finished).

add_input_file([filename, target, database, ...])

Add an input file to the step (but not necessarily to the MPAS model).

add_output_file(filename[, validate_vars, ...])

Add the output file to the step

add_property_check(filename, check_properties)

Add a single conservation comparison for an output file

check_cf()

Check the files added with add_cf_check() for CF compliance.

check_properties()

Check conservation properties of the output files of this step.

constrain_resources(available_resources)

Constrain resources based on available cores.

process_inputs_and_outputs()

Process the inputs to and outputs from a step added with polaris.Step.add_input_file() and polaris.Step.add_output_file().

run()

Run the feature-mask step.

runtime_setup()

Set up runtime filenames after the work-dir config has been edited.

set_resources([cpus_per_task, ...])

Update the resources for the subtask.

set_shared_config(config[, link])

Replace the step's config parser with the shared config parser

setup()

Set up the step, failing early for a model that cannot be packaged.

validate_baselines()

Compare variables between output files in this step and in the same step from a baseline run if one was provided.

work_path(*filenames)

Get the absolute path to a file or directory in the step's work directory

Attributes

cores

the number of cores this step needs, in total

gpus

the number of GPUs this step needs, in total

may_span_nodes

whether this step's cores and GPUs may come from several nodes

min_cores

the number of cores this step needs in order to run at all

min_gpus

the number of GPUs this step requires, in total