polaris.tasks.ocean.seamount.forward.forward_step_name

polaris.tasks.ocean.seamount.forward.forward_step_name(scheme)[source]

The name of the forward step that runs a given pressure-gradient scheme.

Every forward step is named for its scheme, including in tasks that run only one, so that an output directory says which scheme produced it without anyone having to open the model config.

Parameters:

scheme (str) – The pressure-gradient scheme, a key of SCHEMES

Returns:

str – The step name