polaris.tasks.e3sm.init.topo.remap.MaskTopoStep

class polaris.tasks.e3sm.init.topo.remap.MaskTopoStep(component, combine_topo_step, name, subdir)[source]

A step to mask the global topograph dataset for ocean and land regions

Variables:

combine_topo_step (polaris.tasks.e3sm.init.topo.CombineStep) – The step for combining global and Antarctic topography on a cubed sphere grid

__init__(component, combine_topo_step, name, subdir)[source]

Create a new step

Parameters:

  • component (polaris.Component) – The component the step belongs to

  • combine_topo_step (polaris.tasks.e3sm.init.topo.CombineStep) – The step for combining global and Antarctic topography on a cubed sphere grid

  • name (str) – the name of the step

  • subdir (str) – the subdirectory for the step

Methods

__init__(component, combine_topo_step, name, ...)

Create a new step

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 that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.

constrain_resources(available_resources)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

define_masks(ds)

Override in subclasses to return an ocean and a land mask array with the same shape as ds.base_elevation and other topogrpahy fields.

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 step.

runtime_setup()

Update attributes of the step at runtime before calling the run() method.

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 in the work directory and set input files.

validate_baselines()

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