polaris.tasks.e3sm.init.component_inputs.names.ocean_scrip_path

polaris.tasks.e3sm.init.component_inputs.names.ocean_scrip_path(short_name: str, creation_date: str, region: str) → str[source]

Where a SCRIP description is staged beside the ocean products.

The same files are staged under share/meshes/mpas/unified/<id>/ by scrip_path(). They are in both places because developers look for them in both: with the mesh files and with the ocean files that were built from them.

Under ocn/mpas-o/ the ocean in a region name says nothing – every file there is the ocean’s – so it is dropped, leaving <short>.scrip.<date>.nc for the ocean domain and <short>.no_cavities.scrip.<date>.nc for the one without ice-shelf cavities. Land has no copy here, having no business in an ocean directory.

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 OCEAN_SCRIP_REGIONS.

Returns:

str – The path, relative to ASSEMBLED_FILES.

Raises:

ValueError – If region is not a region staged beside the ocean products.