polaris.tasks.e3sm.init.component_inputs.ComponentInputsTask

class polaris.tasks.e3sm.init.component_inputs.ComponentInputsTask(component, mesh_name, target)[source]

A task for staging the E3SM component input files for one mesh.

Three of these exist per mesh, for the ocean products, the sea-ice products and both. They share most of their steps, which is why the tasks live under component_inputs/tasks/ – a task subdirectory could otherwise collide with a step subdirectory of the same name.

Variables:
  • mesh_name (str) – The name of the base mesh.

  • target ({'ocean', 'seaice', 'all'}) – Which products this task stages.

__init__(component, mesh_name, target)[source]

Create the task.

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

  • mesh_name (str) – The name of the base mesh.

  • target ({'ocean', 'seaice', 'all'}) – Which products to stage.

Methods

__init__(component, mesh_name, target)

Create the task.

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

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

configure()

Fill in the creation date so it lands in the work directory's config.

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