Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Mar 22, 2023
1 parent 66dbf5b commit 213f44c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/developers_guide/ocean/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 12 additions & 1 deletion docs/developers_guide/ocean/test_groups/global_ocean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/<mesh_short_name>.<datestamp>.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
Expand All @@ -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/<mesh_short_name>/partitions/mpas-o.graph.info.<datestamp>.part.<core_count>``

: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/<mesh_short_name>.<datestamp>.nc``

:py:class:`compass.ocean.tests.global_ocean.files_for_e3sm.seaice_initial_condition.SeaiceInitialCondition`
extracts the following variables from the restart file:

Expand Down
3 changes: 3 additions & 0 deletions docs/users_guide/ocean/test_groups/global_ocean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 213f44c

Please sign in to comment.