polaris.Component

class polaris.Component(name)[source]

The base class for housing all the tasks for a given component, such as ocean, landice, or seaice

Variables:

  • name (str) – the name of the component

  • tasks (dict) – A dictionary of tasks in the component with the subdirectories of the tasks in the component as keys

  • steps (dict) – A dictionary of steps in the component with the subdirectories of the steps in the component as keys

  • cached_files (dict) – A dictionary that maps from output file names in steps within tasks to cached files in the polaris_cache database for the component. These file mappings are read in from cached_files.json in the component.

__init__(name)[source]

Create a new container for the tasks for a given component

Parameters:

name (str) – the name of the component

Methods

__init__(name)

Create a new container for the tasks for a given component

add_config(config)

Add a shared config to the component

add_step(step)

Add a step to the component

add_task(task)

Add a task to the component

configure(config)

Configure the component

get_or_create_shared_step(step_cls, subdir, ...)

Get a shared step from the component if it exists, otherwise create and add it.

remove_step(step)

Remove the given step from this component