polaris.tasks.ocean.realistic_global.init.steps.get_realistic_init_steps

polaris.tasks.ocean.realistic_global.init.steps.get_realistic_init_steps(component, mesh_name, include_viz=False)

Get shared steps for the realistic global ocean initialization workflow for one MPAS mesh.

Composes the full dependency chain:

• Upstream cull-topography steps from e3sm/init (via get_cull_topo_steps())

• WOA23 hydrography steps (via get_woa23_steps())

• JRA55-do wind-stress steps (via get_jra55_steps())

• CullTopoStep

• Woa23MapStep

• RemapWoa23Step

• Jra55MapStep

• RemapJra55Step

• RealisticPStarInitStep

• InitialStateStep

• ForcingStep

• VizInitStep, only if include_viz is True

All steps are model-independent except InitialStateStep and ForcingStep, which read [ocean] model from config at run time to select the appropriate output format.

All new steps are created via polaris.Component.get_or_create_shared_step() so that they are reused if the same mesh name appears in multiple tasks.

Parameters:

• component (polaris.tasks.ocean.Ocean) – The ocean component the steps belong to.

• mesh_name (str) – The name of the MPAS mesh (e.g. 'icos240km').

• include_viz (bool, optional) – Whether to include the (shared) VizInitStep in the returned steps. The step is always created as a shared component step so it is part of the workflow, but it is only added to the returned dict (and therefore to a task’s steps_to_run) when this is True. The standalone RealisticGlobalInit task passes include_viz=True; other consumers that reuse the init outputs as dependencies leave it False so the plots are not regenerated.

Returns:

• steps (dict of {str: polaris.Step}) – All steps keyed by their suggested symlink names.

• config (polaris.config.PolarisConfigParser) – Per-mesh shared config for the init steps.