polaris.tasks.mesh.spherical.unified.coastline.get_unified_mesh_coastline_steps

polaris.tasks.mesh.spherical.unified.coastline.get_unified_mesh_coastline_steps(resolution, include_viz=False)[source]

Get shared coastline-preparation steps for a lat-lon target grid.

A ComputeCoastlineStep is always created at the finest supported resolution using the finest combined-topography step.

For coarser resolutions, a RemapCoastlineStep is also created to remap the finest-resolution coastline to the requested resolution.

The ComputeCoastlineStep and RemapCoastlineStep set default_cached = True in their constructors because they are expensive to produce. Downstream tasks benefit from cached outputs automatically. Tasks that require free-running execution (e.g. standalone coastline tasks) should add each returned step’s subdir to self.free_running_steps in their __init__, as LatLonCoastlineTask does.

Parameters:

  • resolution (float) – The latitude-longitude resolution in degrees for this grid

  • include_viz (bool, optional) – Whether to include a visualization step

Returns:

  • steps (dict of str to polaris.Step) – The coastline steps keyed by suggested subdir symlink in the task. Contains 'coastline_compute' at resolutions other than the finest; contains 'coastline_final' with the coastline output for downstream workflows; contains 'coastline_viz' when include_viz=True.

  • config (polaris.config.PolarisConfigParser) – The shared config options