polaris.tasks.e3sm.init.topo.cull.CullMaskStep

class polaris.tasks.e3sm.init.topo.cull.CullMaskStep(component, base_mesh_step, unsmoothed_topo_step, name, subdir, sizing_field_step=None)

A step for creating the masks that will be used to cull land and ocean/sea-ice meshes based on critical land and ocean/sea-ice transects, handling land-locked cells, and flood-filling to make sure that Antarctic land ice and ocean are both contiguous.

Variables:

• base_mesh_step (polaris.mesh.spherical.SphericalBaseStep) – The base mesh step containing input files to this step

• unsmoothed_topo_step (polaris.tasks.e3sm.init.topo.RemapTopoStep) – The step for remapping the topography to the MPAS base mesh without smoothing

• sizing_field_step (polaris.Step or None) – For unified meshes, the sizing-field build step whose sizing_field.nc provides the ocean background cell width used by the dcEdge diagnostic

__init__(component, base_mesh_step, unsmoothed_topo_step, name, subdir, sizing_field_step=None)

Create a new step

Parameters:

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

• base_mesh_step (polaris.mesh.spherical.SphericalBaseStep) – The base mesh step containing input files to this step

• unsmoothed_topo_step (polaris.tasks.e3sm.init.topo.RemapTopoStep) – The step for remapping the topography to the MPAS base mesh without smoothing

• name (str) – the name of the step

• subdir (str) – the subdirectory for the step

• sizing_field_step (polaris.Step, optional) – For unified meshes, the sizing-field build step whose sizing_field.nc provides the ocean background cell width used by the dcEdge diagnostic

Methods

__init__(component, base_mesh_step, ...[, ...])	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 to the step
add_property_check(filename, check_properties)	Add a single conservation comparison for an output file
check_properties()	Check conservation properties of the output files of this step.
constrain_resources(available_resources)	Constrain the cores this step uses to the cores available to it
define_critical_land_transects(gf)	Define transects along which land must be present (e.g. to block ocean flow).
define_critical_ocean_transects(gf)	Define transects along which ocean must be present (e.g. to allow ocean flow).
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().
refine_land_cull_mask(ds_base_mesh, ds_topo, ...)	Refine the mask for culling ocean from the land.
refine_ocean_cull_mask(ds_base_mesh, ...)	Refine the mask for culling land and (optionally) grounded ice from the ocean.
run()	Run this step of the test case
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, including downloading any dependencies.
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