diff --git a/compass/ocean/suites/narrm14.txt b/compass/ocean/suites/narrm14.txt new file mode 100644 index 0000000000..f04cc4a03d --- /dev/null +++ b/compass/ocean/suites/narrm14.txt @@ -0,0 +1,5 @@ +ocean/global_ocean/NARRM14/mesh +ocean/global_ocean/NARRM14/WOA23/init +ocean/global_ocean/NARRM14/WOA23/performance_test +ocean/global_ocean/NARRM14/WOA23/dynamic_adjustment +ocean/global_ocean/NARRM14/WOA23/files_for_e3sm diff --git a/compass/ocean/suites/narrmwisc14.txt b/compass/ocean/suites/narrmwisc14.txt new file mode 100644 index 0000000000..30b639469e --- /dev/null +++ b/compass/ocean/suites/narrmwisc14.txt @@ -0,0 +1,5 @@ +ocean/global_ocean/NARRMwISC14/mesh +ocean/global_ocean/NARRMwISC14/WOA23/init +ocean/global_ocean/NARRMwISC14/WOA23/performance_test +ocean/global_ocean/NARRMwISC14/WOA23/dynamic_adjustment +ocean/global_ocean/NARRMwISC14/WOA23/files_for_e3sm diff --git a/compass/ocean/suites/wc14.txt b/compass/ocean/suites/wc14.txt deleted file mode 100644 index 48f22334a4..0000000000 --- a/compass/ocean/suites/wc14.txt +++ /dev/null @@ -1,5 +0,0 @@ -ocean/global_ocean/WC14/mesh -ocean/global_ocean/WC14/WOA23/init -ocean/global_ocean/WC14/WOA23/performance_test -ocean/global_ocean/WC14/WOA23/dynamic_adjustment -ocean/global_ocean/WC14/WOA23/files_for_e3sm diff --git a/compass/ocean/suites/wcwisc14.txt b/compass/ocean/suites/wcwisc14.txt deleted file mode 100644 index 00ece36419..0000000000 --- a/compass/ocean/suites/wcwisc14.txt +++ /dev/null @@ -1,5 +0,0 @@ -ocean/global_ocean/WCwISC14/mesh -ocean/global_ocean/WCwISC14/WOA23/init -ocean/global_ocean/WCwISC14/WOA23/performance_test -ocean/global_ocean/WCwISC14/WOA23/dynamic_adjustment -ocean/global_ocean/WCwISC14/WOA23/files_for_e3sm diff --git a/compass/ocean/tests/global_ocean/__init__.py b/compass/ocean/tests/global_ocean/__init__.py index 6eb83d8b56..82aeeeb799 100644 --- a/compass/ocean/tests/global_ocean/__init__.py +++ b/compass/ocean/tests/global_ocean/__init__.py @@ -45,7 +45,7 @@ def __init__(self, mpas_core): self._add_tests(mesh_names=['SO12to60', 'SOwISC12to60']) - self._add_tests(mesh_names=['WC14', 'WCwISC14']) + self._add_tests(mesh_names=['NARRM14', 'NARRMwISC14']) # RRS6to18: with and without cavities self._add_tests(mesh_names=['RRS6to18', 'RRSwISC6to18']) diff --git a/compass/ocean/tests/global_ocean/global_ocean.cfg b/compass/ocean/tests/global_ocean/global_ocean.cfg index 4bf11f1c6e..38b914e398 100644 --- a/compass/ocean/tests/global_ocean/global_ocean.cfg +++ b/compass/ocean/tests/global_ocean/global_ocean.cfg @@ -79,7 +79,7 @@ forward_update_pio = True ## metadata related to the mesh # whether to add metadata to output files add_metadata = True -# the prefix (e.g. QU, EC, WC, SO) +# the prefix (e.g. QU, EC, NARRM, SO) prefix = PREFIX # a description of the mesh mesh_description = <<>> diff --git a/compass/ocean/tests/global_ocean/mesh/__init__.py b/compass/ocean/tests/global_ocean/mesh/__init__.py index da9884177a..25be98c1a0 100644 --- a/compass/ocean/tests/global_ocean/mesh/__init__.py +++ b/compass/ocean/tests/global_ocean/mesh/__init__.py @@ -11,13 +11,13 @@ from compass.ocean.tests.global_ocean.mesh.fris04to60 import FRIS04to60BaseMesh from compass.ocean.tests.global_ocean.mesh.fris08to60 import FRIS08to60BaseMesh from compass.ocean.tests.global_ocean.mesh.kuroshio import KuroshioBaseMesh +from compass.ocean.tests.global_ocean.mesh.narrm14 import NARRM14BaseMesh from compass.ocean.tests.global_ocean.mesh.qu import ( IcosMeshFromConfigStep, QUMeshFromConfigStep, ) from compass.ocean.tests.global_ocean.mesh.rrs6to18 import RRS6to18BaseMesh from compass.ocean.tests.global_ocean.mesh.so12to60 import SO12to60BaseMesh -from compass.ocean.tests.global_ocean.mesh.wc14 import WC14BaseMesh from compass.ocean.tests.global_ocean.metadata import ( get_author_and_email_from_git, ) @@ -110,8 +110,8 @@ def __init__(self, test_group, mesh_name, high_res_topography): base_mesh_step = FRIS08to60BaseMesh(self, name=name, subdir=subdir) elif mesh_name.startswith('Kuroshio'): base_mesh_step = KuroshioBaseMesh(self, name=name, subdir=subdir) - elif mesh_name in ['WC14', 'WCwISC14']: - base_mesh_step = WC14BaseMesh(self, name=name, subdir=subdir) + elif mesh_name in ['NARRM14', 'NARRMwISC14']: + base_mesh_step = NARRM14BaseMesh(self, name=name, subdir=subdir) else: raise ValueError(f'Unknown mesh name {mesh_name}') diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/__init__.py b/compass/ocean/tests/global_ocean/mesh/narrm14/__init__.py similarity index 92% rename from compass/ocean/tests/global_ocean/mesh/wc14/__init__.py rename to compass/ocean/tests/global_ocean/mesh/narrm14/__init__.py index 7e2ff57bf4..c1347c42cc 100644 --- a/compass/ocean/tests/global_ocean/mesh/wc14/__init__.py +++ b/compass/ocean/tests/global_ocean/mesh/narrm14/__init__.py @@ -14,9 +14,9 @@ from compass.mesh import QuasiUniformSphericalMeshStep -class WC14BaseMesh(QuasiUniformSphericalMeshStep): +class NARRM14BaseMesh(QuasiUniformSphericalMeshStep): """ - A step for creating WC14 mesh + A step for creating NARRM14 mesh """ def setup(self): """ @@ -75,14 +75,10 @@ def build_cell_width_lat_lon(self): fig.set_size_inches(10.0, 14.0) register_sci_viz_colormaps() - # Create cell width vs latitude for Atlantic and Pacific basins - EC60to30 = mdt.EC_CellWidthVsLat(lat) - EC60to30Narrow = mdt.EC_CellWidthVsLat(lat, latPosEq=8.0, - latWidthEq=3.0) - - # Expand from 1D to 2D - _, cellWidth = np.meshgrid(lon, EC60to30Narrow) - _plot_cartopy(2, 'narrow EC60to30', cellWidth, '3Wbgy5') + # start with a uniform 30 km background resolution + dx_max = 30. + cellWidth = dx_max * np.ones((nlat, nlon)) + _plot_cartopy(2, 'Uniform 30 km', cellWidth, '3Wbgy5') plotFrame = 3 # global settings for regionally refines mesh @@ -192,13 +188,6 @@ def build_cell_width_lat_lon(self): _plot_cartopy(plotFrame + 1, 'cellWidth ', cellWidth, '3Wbgy5') plotFrame += 2 - ax = plt.subplot(6, 2, 1) - ax.plot(lat, EC60to30, label='original EC60to30') - ax.plot(lat, EC60to30Narrow, label='narrow EC60to30') - ax.grid(True) - plt.title('Grid cell size [km] versus latitude') - plt.legend(loc="upper left") - plt.savefig('mesh_construction.png', dpi=300) return cellWidth, lon, lat diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/coastline_CUSP.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/coastline_CUSP.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/coastline_CUSP.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/coastline_CUSP.geojson diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/dynamic_adjustment.yaml b/compass/ocean/tests/global_ocean/mesh/narrm14/dynamic_adjustment.yaml similarity index 83% rename from compass/ocean/tests/global_ocean/mesh/wc14/dynamic_adjustment.yaml rename to compass/ocean/tests/global_ocean/mesh/narrm14/dynamic_adjustment.yaml index 31533f6563..d61adc8c52 100644 --- a/compass/ocean/tests/global_ocean/mesh/wc14/dynamic_adjustment.yaml +++ b/compass/ocean/tests/global_ocean/mesh/narrm14/dynamic_adjustment.yaml @@ -5,7 +5,7 @@ dynamic_adjustment: steps: damped_adjustment_1: run_duration: 00_06:00:00 - output_interval: 10_00:00:00 + output_interval: 00_06:00:00 restart_interval: 00_06:00:00 dt: 00:00:30 btr_dt: 00:00:01.5 @@ -13,7 +13,7 @@ dynamic_adjustment: damped_adjustment_2: run_duration: 00_06:00:00 - output_interval: 10_00:00:00 + output_interval: 00_06:00:00 restart_interval: 00_06:00:00 dt: 00:01:00 btr_dt: 00:00:03 @@ -21,7 +21,7 @@ dynamic_adjustment: damped_adjustment_3: run_duration: 00_12:00:00 - output_interval: 10_00:00:00 + output_interval: 00_12:00:00 restart_interval: 00_12:00:00 dt: 00:02:00 btr_dt: 00:00:06 @@ -29,7 +29,7 @@ dynamic_adjustment: damped_adjustment_4: run_duration: 01_00:00:00 - output_interval: 10_00:00:00 + output_interval: 01_00:00:00 restart_interval: 01_00:00:00 dt: 00:03:00 btr_dt: 00:00:09 @@ -37,7 +37,7 @@ dynamic_adjustment: damped_adjustment_5: run_duration: 01_00:00:00 - output_interval: 10_00:00:00 + output_interval: 01_00:00:00 restart_interval: 01_00:00:00 dt: 00:05:00 btr_dt: 00:00:12 @@ -45,7 +45,7 @@ dynamic_adjustment: damped_adjustment_6: run_duration: 03_00:00:00 - output_interval: 10_00:00:00 + output_interval: 03_00:00:00 restart_interval: 03_00:00:00 dt: 00:07:30 btr_dt: 00:00:15 @@ -53,7 +53,7 @@ dynamic_adjustment: simulation: run_duration: 24_00:00:00 - output_interval: 10_00:00:00 + output_interval: 06_00:00:00 restart_interval: 06_00:00:00 dt: 00:10:00 btr_dt: 00:00:15 diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/land_mask_Kamchatka.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/land_mask_Kamchatka.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/land_mask_Kamchatka.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/land_mask_Kamchatka.geojson diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/land_mask_Mexico.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/land_mask_Mexico.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/land_mask_Mexico.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/land_mask_Mexico.geojson diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/namelist.split_explicit_ab2 b/compass/ocean/tests/global_ocean/mesh/narrm14/namelist.split_explicit_ab2 similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/namelist.split_explicit_ab2 rename to compass/ocean/tests/global_ocean/mesh/narrm14/namelist.split_explicit_ab2 diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/wc14.cfg b/compass/ocean/tests/global_ocean/mesh/narrm14/narrm14.cfg similarity index 51% rename from compass/ocean/tests/global_ocean/mesh/wc14/wc14.cfg rename to compass/ocean/tests/global_ocean/mesh/narrm14/narrm14.cfg index 6e4d0510cc..f943153917 100644 --- a/compass/ocean/tests/global_ocean/mesh/wc14/wc14.cfg +++ b/compass/ocean/tests/global_ocean/mesh/narrm14/narrm14.cfg @@ -2,23 +2,7 @@ [vertical_grid] # the type of vertical grid -grid_type = index_tanh_dz - -# Number of vertical levels -vert_levels = 64 - -# Depth of the bottom of the ocean -bottom_depth = 5500.0 - -# The minimum layer thickness -min_layer_thickness = 10.0 - -# The maximum layer thickness -max_layer_thickness = 250.0 - -# The characteristic number of levels over which the transition between -# the min and max occurs -transition_levels = 28 +grid_type = 80layerE3SMv1 # options for global ocean testcases @@ -28,24 +12,25 @@ transition_levels = 28 approx_cell_count = 410000 ## metadata related to the mesh -# the prefix (e.g. QU, EC, WC, SO) -prefix = WC +# the prefix (e.g. QU, EC, NARRM, SO) +prefix = NARRM # a description of the mesh and initial condition -mesh_description = MPAS North America and Arctic Focused Water Cycle mesh for E3SM version - ${e3sm_version}, with a focused ${min_res}-km resolution - around North America and <<>> vertical levels +mesh_description = MPAS North America and Arctic Regionally Refined Mesh for + E3SM version ${e3sm_version}, with ${min_res}-km resolution + in these regions, ${max_res} elsewhere and <<>> + vertical levels # E3SM version that the mesh is intended for e3sm_version = 3 # The revision number of the mesh, which should be incremented each time the # mesh is revised -mesh_revision = 1 +mesh_revision = 2 # the minimum (finest) resolution in the mesh min_res = 14 # the maximum (coarsest) resolution in the mesh, can be the same as min_res -max_res = 60 +max_res = 30 # The URL of the pull request documenting the creation of the mesh -pull_request = https://github.com/MPAS-Dev/MPAS-Model/pull/628 +pull_request = https://github.com/MPAS-Dev/MPAS-Model/pull/783 # config options related to initial condition and diagnostics support files diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/region_Arctic_Ocean.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Arctic_Ocean.geojson similarity index 99% rename from compass/ocean/tests/global_ocean/mesh/wc14/region_Arctic_Ocean.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/region_Arctic_Ocean.geojson index 12d60f9e6c..1141e636f7 100644 --- a/compass/ocean/tests/global_ocean/mesh/wc14/region_Arctic_Ocean.geojson +++ b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Arctic_Ocean.geojson @@ -66,4 +66,4 @@ } } ] -} \ No newline at end of file +} diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/region_Bering_Sea.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Bering_Sea.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/region_Bering_Sea.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/region_Bering_Sea.geojson diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/region_Bering_Sea_reduced.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Bering_Sea_reduced.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/region_Bering_Sea_reduced.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/region_Bering_Sea_reduced.geojson diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/region_Central_America.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Central_America.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/region_Central_America.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/region_Central_America.geojson diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/region_Gulf_Stream_extension.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Gulf_Stream_extension.geojson similarity index 99% rename from compass/ocean/tests/global_ocean/mesh/wc14/region_Gulf_Stream_extension.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/region_Gulf_Stream_extension.geojson index d558e79aff..eb7edf7195 100644 --- a/compass/ocean/tests/global_ocean/mesh/wc14/region_Gulf_Stream_extension.geojson +++ b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Gulf_Stream_extension.geojson @@ -54,4 +54,4 @@ } } ] -} \ No newline at end of file +} diff --git a/compass/ocean/tests/global_ocean/mesh/wc14/region_Gulf_of_Mexico.geojson b/compass/ocean/tests/global_ocean/mesh/narrm14/region_Gulf_of_Mexico.geojson similarity index 100% rename from compass/ocean/tests/global_ocean/mesh/wc14/region_Gulf_of_Mexico.geojson rename to compass/ocean/tests/global_ocean/mesh/narrm14/region_Gulf_of_Mexico.geojson diff --git a/docs/design_docs/cached_outputs.rst b/docs/design_docs/cached_outputs.rst index 4548bd461c..8418fc9273 100644 --- a/docs/design_docs/cached_outputs.rst +++ b/docs/design_docs/cached_outputs.rst @@ -35,7 +35,7 @@ Contributors: Xylar Asay-Davis Each ``compass`` step defines its output files in the ``compass.Step.outputs`` attribute. For selected steps (see :ref:`req_select`), we require a mechanism to download cached files for each of these outputs and to use these cached -files for the outputs of the step instead of computing them. +files for the outputs of the step instead of computing them. .. _req_select: @@ -48,7 +48,7 @@ Contributors: Xylar Asay-Davis There needs to be a mechanism for developers and users to select which steps are run as normal and which use cached outputs. For this mechanism to be -practical, it should not be overly tedious or manual (e.g. manually setting a +practical, it should not be overly tedious or manual (e.g. manually setting a flag for each step). .. _req_update: @@ -72,11 +72,11 @@ Date last modified: 2021/07/30 Contributors: Xylar Asay-Davis -There should be a mechanism for giving each cached output file a unique -identifier (such as a date stamp). A given version (git hash or release) of +There should be a mechanism for giving each cached output file a unique +identifier (such as a date stamp). A given version (git hash or release) of ``compass`` should know which cached files to download. Older cached files should be retained so that older versions of ``compass`` can still be used -with these cached files. +with these cached files. .. note:: @@ -109,14 +109,14 @@ Date last modified: 2021/07/30 Contributors: Xylar Asay-Davis -``compass`` supports "databases" of input data files on the E3SM +``compass`` supports "databases" of input data files on the E3SM `LCRC server `_. -Files will be stored in a new ``compass_cache`` database within each MPAS +Files will be stored in a new ``compass_cache`` database within each MPAS core's space on that server. If the "cached" version of a step is selected -(see :ref:`des_select`), an appropriate "input" file will be added to the test +(see :ref:`des_select`), an appropriate "input" file will be added to the test case where the "target" is the file on the LCRC server to be cached locally for future use and the "filename" is the output file. ``compass`` will know which -files on the server correspond to which output files via a python dictionary, +files on the server correspond to which output files via a python dictionary, as described in :ref:`des_unique`. .. _des_select: @@ -403,9 +403,9 @@ The implementation leans heavily on the assumption that a given step will either be run with cached outputs or as normal, so that both versions are not available in the same work directory or as part of the same test suite. -Nevertheless, if a separate "cached" version of a step were desired, it would -be necessary to make symlinks from the cached files in the location of the -"uncached" version of the step to the location of the "cached" version. For +Nevertheless, if a separate "cached" version of a step were desired, it would +be necessary to make symlinks from the cached files in the location of the +"uncached" version of the step to the location of the "cached" version. For example, if the "uncached" step is .. code-block:: none @@ -422,7 +422,7 @@ symlinks could be created on the LCRC server, e.g. .. code-block:: none - /lcrc/group/e3sm/public_html/mpas_standalonedata/mpas-ocean/compass_cache/global_ocean/QU240/cached/mesh/mesh/culled_mesh.210803.nc + /lcrc/group/e3sm/public_html/mpas_standalonedata/mpas-ocean/compass_cache/global_ocean/QU240/cached/mesh/mesh/culled_mesh.210803.nc -> /lcrc/group/e3sm/public_html/mpas_standalonedata/mpas-ocean/compass_cache/global_ocean/QU240/mesh/mesh/culled_mesh.210803.nc and the ``cached`` attribute could be set to ``True`` in the constructor of the @@ -452,8 +452,8 @@ using test-case runs on Chrysalis. ocean/global_ocean/QUwISC240/PHC/init/ssh_adjustment/ ocean/global_ocean/EC30to60/mesh/mesh/ ocean/global_ocean/EC30to60/PHC/init/initial_state/ - ocean/global_ocean/WC14/mesh/mesh/ - ocean/global_ocean/WC14/PHC/init/initial_state/ + ocean/global_ocean/NARRM14/mesh/mesh/ + ocean/global_ocean/NARRM14/PHC/init/initial_state/ ocean/global_ocean/ECwISC30to60/mesh/mesh/ ocean/global_ocean/ECwISC30to60/PHC/init/initial_state/ ocean/global_ocean/ECwISC30to60/PHC/init/ssh_adjustment/ diff --git a/docs/design_docs/compass_package.rst b/docs/design_docs/compass_package.rst index b9a55cdb2e..824cee8bf5 100644 --- a/docs/design_docs/compass_package.rst +++ b/docs/design_docs/compass_package.rst @@ -1550,7 +1550,7 @@ metadata to include in the output files: forward_max_disk = 1000 ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = EC # a description of the mesh and initial condition mesh_description = MPAS Eddy Closure mesh for E3SM version ${e3sm_version} with diff --git a/docs/developers_guide/ocean/api.rst b/docs/developers_guide/ocean/api.rst index edb7822257..0074d2925a 100644 --- a/docs/developers_guide/ocean/api.rst +++ b/docs/developers_guide/ocean/api.rst @@ -239,8 +239,8 @@ test cases and steps mesh.so12to60.SO12to60BaseMesh mesh.so12to60.SO12to60BaseMesh.build_cell_width_lat_lon - mesh.wc14.WC14BaseMesh - mesh.wc14.WC14BaseMesh.build_cell_width_lat_lon + mesh.narrm14.NARRM14BaseMesh + mesh.narrm14.NARRM14BaseMesh.build_cell_width_lat_lon performance_test.PerformanceTest performance_test.PerformanceTest.configure diff --git a/docs/developers_guide/ocean/test_groups/global_ocean.rst b/docs/developers_guide/ocean/test_groups/global_ocean.rst index e4c2394f8b..66937e9730 100644 --- a/docs/developers_guide/ocean/test_groups/global_ocean.rst +++ b/docs/developers_guide/ocean/test_groups/global_ocean.rst @@ -46,7 +46,7 @@ The values of some of the metadata are given in config options: ## metadata related to the mesh # whether to add metadata to output files add_metadata = True - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = PREFIX # a description of the mesh mesh_description = <<>> @@ -87,7 +87,7 @@ defines: ... ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = EC # a description of the mesh and initial condition mesh_description = MPAS Eddy Closure mesh for E3SM version ${e3sm_version} with @@ -371,7 +371,7 @@ The default config options for these meshes are: approx_cell_count = 7400 ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = QU # a description of the mesh mesh_description = MPAS quasi-uniform mesh for E3SM version ${e3sm_version} at @@ -454,7 +454,7 @@ The default config options for these meshes are: [global_ocean] ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = QU # a description of the mesh @@ -486,7 +486,7 @@ corresponding QU config options above: [global_ocean] ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = Icos # a description of the mesh @@ -552,7 +552,7 @@ The default config options for these meshes are: approx_cell_count = 240000 ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = EC # a description of the mesh and initial condition mesh_description = MPAS Eddy Closure mesh for E3SM version ${e3sm_version} with @@ -612,7 +612,7 @@ module: [global_ocean] ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO, Kuroshio) + # the prefix (e.g. QU, EC, NARRM, SO, Kuroshio) prefix = Kuroshio # a description of the mesh and initial condition mesh_description = MPAS Kuroshio regionally refined mesh for E3SM version @@ -694,7 +694,7 @@ The default config options for these meshes are: approx_cell_count = 3700000 ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = RRS # a description of the mesh and initial condition mesh_description = MPAS Eddy Closure mesh for E3SM version ${e3sm_version} with @@ -820,7 +820,7 @@ The default config options for these meshes are: approx_cell_count = 570000 ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = SO # a description of the mesh and initial condition mesh_description = MPAS Southern Ocean regionally refined mesh for E3SM version @@ -855,20 +855,19 @@ The vertical grid is an ``index_tanh_dz`` profile (see :ref:`dev_ocean_framework_vertical`) with 64 vertical levels ranging in thickness from 10 to 250 m. -.. _dev_ocean_global_ocean_wc14: +.. _dev_ocean_global_ocean_narrm14: -WC14 and WCwISC14 -+++++++++++++++++ +NARRM14 and NARRMwISC14 ++++++++++++++++++++++++ -The ``WC14`` and ``WCwISC14`` meshes are the Water Cycle regionally refined -meshes for E3SM v3. They have higher resolution (~14-km) around the continental +The ``NARRM14`` and ``NARRMwISC14`` meshes are the North American Regionally Refined +Meshes for E3SM v3. They have higher resolution (~14-km) around the continental US, the Arctic Ocean, and a section of the North Atlantic containing the Gulf -Stream. The resolution elsewhere varies between 35 km at the South Pole to 60 -km at mid latitudes, with a band of 30-km resolution around the equator. +Stream. The resolution is uniformly about 30 km elsewhere. -The class :py:class:`compass.ocean.tests.global_ocean.mesh.wc14.WC14BaseMesh` +The class :py:class:`compass.ocean.tests.global_ocean.mesh.narrm14.NARRM14BaseMesh` defines the resolution for the meshes. The -``compass.ocean.tests.global_ocean.mesh.wc14`` module includes namelist options +``compass.ocean.tests.global_ocean.mesh.narrm14`` module includes namelist options appropriate for forward simulations with split-explicit (but not RK4) time integration on these meshes. These set the time step and default run duration for short runs with these meshes. @@ -907,12 +906,13 @@ The default config options for these meshes are: approx_cell_count = 410000 ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) - prefix = WC + # the prefix (e.g. QU, EC, NARRM, SO) + prefix = NARRM # a description of the mesh and initial condition - mesh_description = MPAS North America and Arctic Focused Water Cycle mesh for E3SM version - ${e3sm_version}, with a focused ${min_res}-km resolution - around North America and <<>> vertical levels + mesh_description = MPAS North America and Arctic Regionally Refined Mesh for + E3SM version ${e3sm_version}, with ${min_res}-km resolution + in these regions, ${max_res} elsewhere and <<>> + vertical levels # E3SM version that the mesh is intended for e3sm_version = 3 @@ -922,9 +922,9 @@ The default config options for these meshes are: # the minimum (finest) resolution in the mesh min_res = 14 # the maximum (coarsest) resolution in the mesh, can be the same as min_res - max_res = 60 + max_res = 30 # The URL of the pull request documenting the creation of the mesh - pull_request = https://github.com/MPAS-Dev/MPAS-Model/pull/628 + pull_request = https://github.com/MPAS-Dev/MPAS-Model/pull/782 # config options related to initial condition and diagnostics support files diff --git a/docs/users_guide/config_files.rst b/docs/users_guide/config_files.rst index a6e173db26..e91c06ce64 100644 --- a/docs/users_guide/config_files.rst +++ b/docs/users_guide/config_files.rst @@ -347,7 +347,7 @@ looks like: add_metadata = True ## metadata related to the mesh - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) # source: /home/xylar/code/compass/customize_config_parser/compass/ocean/tests/global_ocean/mesh/qu240/qu240.cfg prefix = QU diff --git a/docs/users_guide/ocean/test_groups/global_ocean.rst b/docs/users_guide/ocean/test_groups/global_ocean.rst index 5219141d70..6c2bc859f1 100644 --- a/docs/users_guide/ocean/test_groups/global_ocean.rst +++ b/docs/users_guide/ocean/test_groups/global_ocean.rst @@ -102,7 +102,7 @@ Note that meshes and test cases may modify these options, as noted below. ## metadata related to the mesh # whether to add metadata to output files add_metadata = True - # the prefix (e.g. QU, EC, WC, SO) + # the prefix (e.g. QU, EC, NARRM, SO) prefix = PREFIX # a description of the mesh mesh_description = <<>> @@ -456,22 +456,20 @@ in the North Pacific, and 35 km in the Arctic. The mesh includes the :width: 500 px :align: center -.. _global_ocean_mesh_wc14: +.. _global_ocean_mesh_narrm14: -WC14 and WCwISC14 -^^^^^^^^^^^^^^^^^ +NARRM14 and NARRMwISC14 +^^^^^^^^^^^^^^^^^^^^^^^ -The Water Cycle 14- to 60-km mesh (WC14) is intended to be the main regionally -refined simulation mesh for the -`E3SM v2 Water Cycle Science Campaign `_. -The E3SM v3 Water Cycle Changes and Impacts Campaign is expected to use the -same mesh but including ice-shelf cavities (WCwISC14). +The North American Regionally Refined 14- to 30-km Mesh (NARRM14) is a +mesh for several +`E3SM v3 Science Campaigns `_. The mesh has 14 km resolution around the continental US, Arctic Ocean and parts -of the North Atlantic, tapering to 60 km in mid latitudes, 30 km at the -equator, and 35 km around Antarctica. +of the North Atlantic, with 30 km uniform resolution elsewhere around the +globe. -.. image:: images/wc14.png +.. image:: images/narrm14.png :width: 500 px :align: center diff --git a/docs/users_guide/ocean/test_groups/images/narrm14.png b/docs/users_guide/ocean/test_groups/images/narrm14.png new file mode 100644 index 0000000000..b90bce35f6 Binary files /dev/null and b/docs/users_guide/ocean/test_groups/images/narrm14.png differ diff --git a/docs/users_guide/ocean/test_groups/images/wc14.png b/docs/users_guide/ocean/test_groups/images/wc14.png deleted file mode 100644 index fec2811fc2..0000000000 Binary files a/docs/users_guide/ocean/test_groups/images/wc14.png and /dev/null differ diff --git a/docs/users_guide/quick_start.rst b/docs/users_guide/quick_start.rst index 2f875ad713..18d4cc95f4 100644 --- a/docs/users_guide/quick_start.rst +++ b/docs/users_guide/quick_start.rst @@ -430,8 +430,8 @@ The output is: -c ocean -t quwisc240_for_e3sm -c ocean -t so12to60 -c ocean -t sowisc12to60 - -c ocean -t wc14 - -c ocean -t wcwisc14 + -c ocean -t narrm14 + -c ocean -t narrmwisc14 -c ocean -t wetdry You can set up a suite as follows: diff --git a/docs/users_guide/test_suites.rst b/docs/users_guide/test_suites.rst index bea5dd7582..f14ad6dc48 100644 --- a/docs/users_guide/test_suites.rst +++ b/docs/users_guide/test_suites.rst @@ -43,8 +43,8 @@ the current set of available test suites is: -c ocean -t quwisc240_for_e3sm -c ocean -t so12to60 -c ocean -t sowisc12to60 - -c ocean -t wc14 - -c ocean -t wcwisc14 + -c ocean -t narrm14 + -c ocean -t narrmwisc14 -c ocean -t wetdry As an example, the ocean ``nightly`` test suite includes the test cases used