polaris.tasks.e3sm.init.component_inputs.seaice_partition_map.SeaicePartitionMapStep

class polaris.tasks.e3sm.init.component_inputs.seaice_partition_map.SeaicePartitionMapStep(component, subdir, seaice_mesh_step, name='seaice_partition_map')[source]

A step for building the bilinear mapping file from the QU60km sea-ice climatology to the sea-ice mesh.

This is the MPI half of the sea-ice partitioning workflow; SeaiceGraphPartitionStep applies the resulting weights. Splitting the two follows the same division as the WOA23 and JRA55-do remapping in realistic_global: building weights is an MPI job sized for the mapping tool, and using them is not.

Variables:
  • seaice_mesh_step (polaris.Step) – The step that wrote seaice_mesh.nc, the mesh the weights map onto.

  • mesh_short_name (str or None) – The E3SM short name of the mesh, used to label the mapping file. It is not known until setup() reads it from config.

__init__(component, subdir, seaice_mesh_step, name='seaice_partition_map')[source]

Create a new step.

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

  • subdir (str) – The subdirectory for the step.

  • seaice_mesh_step (polaris.Step) – The step that wrote seaice_mesh.nc.

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

Methods

__init__(component, subdir, seaice_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 cpus_per_task and ntasks based on the number of cores available to this step

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()

Set up the source and destination grids, then the command that builds the QU60km-to-mesh mapping file.

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()

Resolve what the mapping file is named after, before anything runs.

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