polaris.tasks.ocean.realistic_global.analysis_output.AnalysisOutput

class polaris.tasks.ocean.realistic_global.analysis_output.AnalysisOutput(component, mesh_name: str, init_condition: InitialCondition, init_steps: Dict[str, Step] | None = None)[source]

A one-year Omega run that writes the monthly means, overturning streamfunction and daily global statistics the ocean analysis reads

The run’s settings come from [realistic_global_forward] and the defaults in analysis_output.cfg, with the mesh’s options and then one_year.cfg layered on top. Only the forward step runs by default; global_stats plots the daily statistics.

__init__(component, mesh_name: str, init_condition: InitialCondition, init_steps: Dict[str, Step] | None = None)[source]

Create the task

Parameters:
  • component (polaris.tasks.ocean.Ocean) – The ocean component the task belongs to

  • mesh_name (str) – The name of the mesh (e.g. e3sm-qu240)

  • init_condition (InitialCondition) – The source of the model input files

  • init_steps (dict of polaris.Step, optional) – Shared upstream steps to add to the task, keyed by the symlink name to give them. Needed when init_condition consumes their outputs, and left unset for a cached initial condition.

Methods

__init__(component, mesh_name, init_condition)

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