polaris.tasks.e3sm.init.component_inputs.names.get_mesh_short_name

polaris.tasks.e3sm.init.component_inputs.names.get_mesh_short_name(config: PolarisConfigParser) → str

The E3SM short name of the mesh the files are staged for.

A Polaris mesh name says how a mesh was built (u-oi30-lr10); an E3SM short name identifies a released mesh (u02-oi30-lr10), and the two-digit ID is what distinguishes two meshes built to the same recipe at different times. Only a person can decide a mesh has earned one, so there is no default and no autodetection from a restart file’s global attributes.

Unified meshes register theirs as [unified_mesh] e3sm_short_name. [component_inputs] mesh_short_name overrides that when set.

Parameters:

config (polaris.config.PolarisConfigParser) – The config options for the component-input steps.

Returns:

str – The E3SM short name.

Raises:

ValueError – If neither option is set.