polaris.tasks.e3sm.init.topo.cull.CullTopoTask

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

A task for culling a topography dataset to land and ocea regions (the latter both with and without ice-shelf cavities)

Variables:

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

__init__(component, mesh_name, include_viz=False)[source]

Create a new task

Parameters:

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

  • mesh_name (str) – The name of the base mesh to cull topography onto

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

Methods

__init__(component, mesh_name[, include_viz])

Create a new task

add_step([step, subdir, symlink, run_by_default])

Add a step to the task and component (if not already present)

configure()

Modify the configuration options for this task.

remove_step(step)

Remove the given step from this task and the component

set_shared_config(config[, link])

Replace the task's config parser with the shared config parser