polaris.tasks.ocean.customizable_viz.CustomizableViz

class polaris.tasks.ocean.customizable_viz.CustomizableViz(component)[source]

A customizable visualization task for MPAS output

__init__(component)[source]

Create a new task

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

  • name (str) – the name of the task

  • subdir (str, optional) –

    the subdirectory for the task. If neither this nor indir

    are provided, the directory is the name

  • indir (str, optional) – the directory the task is in, to which name will be appended

Methods

__init__(component)

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