polaris.tasks.e3sm.init.topo.cull.get_cull_topo_steps

polaris.tasks.e3sm.init.topo.cull.get_cull_topo_steps(mesh_name, include_viz=False)[source]

Get shared steps for masking and culling topography for one base mesh.

Includes all upstream remap-topography steps and then adds the steps for creating cull masks for the ocean (with and without ice-shelf cavities) and the land, followed by culling the base mesh to each of these regions.

Parameters:
  • mesh_name (str) – The name of the base mesh to cull

  • include_viz (bool, optional) – Whether to include upstream remap visualization steps

Returns:

  • steps (dict of str to polaris.Step) – All upstream shared steps plus the cull-mask and cull-mesh steps, keyed by suggested symlink in tasks.

  • config (polaris.config.PolarisConfigParser) – The shared config options for culling topography.