From 4053000c56f8f7e9492d9c28077295d05a56d405 Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Tue, 21 Mar 2023 19:03:06 +0100 Subject: [PATCH] Update documentation --- docs/developers_guide/ocean/api.rst | 4 ++++ .../ocean/test_groups/global_ocean.rst | 13 ++++++++++++- docs/users_guide/ocean/test_groups/global_ocean.rst | 3 +++ 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/developers_guide/ocean/api.rst b/docs/developers_guide/ocean/api.rst index 297c6cea0f..3a5fd9c18c 100644 --- a/docs/developers_guide/ocean/api.rst +++ b/docs/developers_guide/ocean/api.rst @@ -168,12 +168,16 @@ test cases and steps files_for_e3sm.ocean_graph_partition.OceanGraphPartition.run files_for_e3sm.ocean_initial_condition.OceanInitialCondition files_for_e3sm.ocean_initial_condition.OceanInitialCondition.run + files_for_e3sm.ocean_mesh.OceanMesh + files_for_e3sm.ocean_mesh.OceanMesh.run files_for_e3sm.scrip.Scrip files_for_e3sm.scrip.Scrip.run files_for_e3sm.seaice_graph_partition.SeaiceGraphPartition files_for_e3sm.seaice_graph_partition.SeaiceGraphPartition.run files_for_e3sm.seaice_initial_condition.SeaiceInitialCondition files_for_e3sm.seaice_initial_condition.SeaiceInitialCondition.run + files_for_e3sm.seaice_mesh.SeaiceMesh + files_for_e3sm.seaice_mesh.SeaiceMesh.run files_for_e3sm.e3sm_to_cmip_maps.E3smToCmipMaps files_for_e3sm.e3sm_to_cmip_maps.E3smToCmipMaps.run files_for_e3sm.diagnostic_maps.DiagnosticMaps diff --git a/docs/developers_guide/ocean/test_groups/global_ocean.rst b/docs/developers_guide/ocean/test_groups/global_ocean.rst index fc2ac5db57..4c47de8f08 100644 --- a/docs/developers_guide/ocean/test_groups/global_ocean.rst +++ b/docs/developers_guide/ocean/test_groups/global_ocean.rst @@ -925,7 +925,13 @@ The test case is constructed with an argument ``restart_filename``. the final restart file produced by the :ref:`dev_ocean_global_ocean_dynamic_adjustment` for the given mesh. -The test case is made up of 8 steps: +The test case is made up of 10 steps: + +:py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.ocean_mesh.OceanMesh` + uses variables from the ocean initial condition and computes others to + create an ocean mesh file (with both horizontal and vertical coordinate + information), creating a symlink + at ``assembled_files/inputdata/share/meshes/mpas/ocean/..nc`` :py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.ocean_initial_condition.OceanInitialCondition` takes out the ``xtime`` variable from the restart file, creating a symlink @@ -939,6 +945,11 @@ The test case is made up of 8 steps: Symlinks to the graph files are placed at ``assembled_files/inputdata/ocn/mpas-o//partitions/mpas-o.graph.info..part.`` +:py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.seaice_mesh.SeaiceMesh` + uses variables from the ocean initial condition to create a sea-ice mesh + file (with horizontal coordinate information), creating a symlink + at ``assembled_files/inputdata/share/meshes/mpas/sea-ice/..nc`` + :py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.seaice_initial_condition.SeaiceInitialCondition` extracts the following variables from the restart file: diff --git a/docs/users_guide/ocean/test_groups/global_ocean.rst b/docs/users_guide/ocean/test_groups/global_ocean.rst index dc5339fa62..c0f0cac116 100644 --- a/docs/users_guide/ocean/test_groups/global_ocean.rst +++ b/docs/users_guide/ocean/test_groups/global_ocean.rst @@ -171,6 +171,9 @@ Note that meshes and test cases may modify these options, as noted below. # directory of an ocean restart file on the given mesh ocean_restart_filename = autodetect + # the initial state used to extract the ocean and sea-ice meshes + ocean_initial_state_filename = ${ocean_restart_filename} + # the absolute path or relative path with respect to the test case's work # directory of a graph file that corresponds to the mesh graph_filename = autodetect