polaris.tasks.mesh.spherical.feature_masks.ComputeFeatureMasksStep

class polaris.tasks.mesh.spherical.feature_masks.ComputeFeatureMasksStep(component, name='compute_feature_masks', subdir=None, mesh_step=None, mesh_filename=None, mesh_name=None, mask_group=None)

A step for creating region or transect masks on a standard MPAS mesh.

__init__(component, name='compute_feature_masks', subdir=None, mesh_step=None, mesh_filename=None, mesh_name=None, mask_group=None)

Create a new feature-mask step.

Parameters:

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

• name (str, optional) – The name of the step

• subdir (str, optional) – The subdirectory for the step

• mesh_step (polaris.Step, optional) – An upstream step that produces the mesh

• mesh_filename (str, optional) – The mesh filename, either from mesh_step or configurable task config

• mesh_name (str, optional) – The mesh name for output filenames and metadata

• mask_group (str, optional) – A group name supported by get_aggregator_by_name()

Methods

__init__(component[, name, subdir, ...])	Create a new feature-mask 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 in the work directory, including linking inputs.
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