polaris.tasks.e3sm.init.component_inputs.names.culled_mesh_path

polaris.tasks.e3sm.init.component_inputs.names.culled_mesh_path(short_name: str, creation_date: str, region: str) → str

Where one culled mesh is staged.

Next to the base mesh under share/meshes/mpas/unified/<id>/ rather than under a component’s own directory, for the same reason the base mesh is there: a culled mesh describes a domain of the unified mesh, not a file one component reads at run time. Compass files its ocean mesh under share/meshes/mpas/ocean/ and E3SM never reads it from ocn/mpas-o/, where an earlier version of this workflow put it.

The ocean mesh carries the vertical coordinate as well, since that is what makes it an ocean mesh rather than a horizontal one; the land mesh is staged as the cull step wrote it.

Parameters:

• short_name (str) – The E3SM short name of the mesh.

• creation_date (str) – The creation date, as YYYYMMDD.

• region (str) – The culled-mesh region, one of MESH_REGIONS.

Returns:

str – The path, relative to ASSEMBLED_FILES.

Raises:

ValueError – If region is not a region whose mesh is staged.