polaris.tasks.ocean.mixed_layer_eddies.comparison.Comparison

class polaris.tasks.ocean.mixed_layer_eddies.comparison.Comparison(component, indir, resolved_steps, coarse_steps)[source]

The comparison of the coarse runs of the mixed-layer eddies tasks with the eddy-resolving reference run

__init__(component, indir, resolved_steps, coarse_steps)[source]

Create the task

Parameters:

  • component (polaris.tasks.ocean.Ocean) – The ocean component that this task belongs to

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

  • resolved_steps (dict of polaris.Step) – The shared init, spinup and eddies steps of the resolved run

  • coarse_steps (dict of dict of polaris.Step) – The shared steps at each coarse resolution, keyed by the resolution’s directory name and then the step name

Methods

__init__(component, indir, resolved_steps, ...)

Create the 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