polaris.tasks.e3sm.init.topo.remap.RemapTopoStep

class polaris.tasks.e3sm.init.topo.remap.RemapTopoStep(component, base_mesh_step, combine_topo_step, mask_topo_step, name, subdir, smoothing=False, unsmoothed_topo=None)

A step for remapping topography data such as base elevation and ice sheet properites from a cubed-sphere grid to a global MPAS base mesh.

Note: This step cannot descend from {py:class}`polaris.remap.MappingFileStep` because the soruce mesh is a cubed-sphere grid, which is not currently supported by pyremap.

Variables:

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

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

• mask_topo_step (polaris.tasks.e3sm.init.topo.MaskTopoStep) – The step that applies a mask to a global topography dataset on a cubed sphere grid

• smoothing (bool, optional) – Whether smoothing will be applied as part of the remapping

• unsmoothed_topo (polaris.tasks.e3sm.init.topo.RemapTopoStep, optional) – A step with unsmoothed topography

• expand_distance (float or xarray.DataArray) – The distance to expand the topography mask

• expand_factor (float or xarray.DataArray) – The factor to expand the topography mask

• do_remapping (bool) – Whether to remap the topography. If False, the step will symlink to the unsmoothed topography file.

__init__(component, base_mesh_step, combine_topo_step, mask_topo_step, name, subdir, smoothing=False, unsmoothed_topo=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

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

• mask_topo_step (polaris.tasks.e3sm.init.topo.MaskTopoStep) – The step that applies a mask to a global topography dataset on a cubed sphere grid

• name (str) – the name of the step

• subdir (str) – the subdirectory for the step

• smoothing (bool, optional) – Whether smoothing will be applied as part of the remapping

• unsmoothed_topo (polaris.tasks.e3sm.init.topo.RemapTopoStep, optional) – A step with unsmoothed topography

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 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_smoothing(ds_unsmoothed)	Define smoothing expand_distance and expand_factor 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 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.