Skip to content

Commit

Permalink
Update global ocean config options in User's Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Aug 17, 2022
1 parent 0cd4ef7 commit db62191
Showing 1 changed file with 29 additions and 21 deletions.
50 changes: 29 additions & 21 deletions docs/users_guide/ocean/test_groups/global_ocean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,44 +33,42 @@ Note that meshes and test cases may modify these options, as noted below.

.. code-block:: cfg
# options for global ocean testcases
[global_ocean]
## each mesh should replace these with appropriate values in its config file
# options for spherical meshes
[spherical_mesh]
## config options related to the mesh step
## config options related to the step for culling land from the mesh
# number of cores to use
mesh_cores = 1
cull_mesh_cpus_per_task = 18
# minimum of cores, below which the step fails
mesh_min_cores = 1
cull_mesh_min_cpus_per_task = 1
# maximum memory usage allowed (in MB)
mesh_max_memory = 1000
# maximum disk usage allowed (in MB)
mesh_max_disk = 1000
cull_mesh_max_memory = 1000
# options for global ocean testcases
[global_ocean]
## each mesh should replace these with appropriate values in its config file
## config options related to the initial_state step
# number of cores to use
init_cores = 4
init_ntasks = 4
# minimum of cores, below which the step fails
init_min_cores = 1
init_min_tasks = 1
# maximum memory usage allowed (in MB)
init_max_memory = 1000
# maximum disk usage allowed (in MB)
init_max_disk = 1000
# number of threads
init_threads = 1
## config options related to the forward steps
# number of cores to use
forward_cores = 4
forward_ntasks = 4
# minimum of cores, below which the step fails
forward_min_cores = 1
forward_min_tasks = 1
# number of threads
forward_threads = 1
# maximum memory usage allowed (in MB)
forward_max_memory = 1000
# maximum disk usage allowed (in MB)
forward_max_disk = 1000
## metadata related to the mesh
# whether to add metadata to output files
Expand Down Expand Up @@ -105,6 +103,16 @@ Note that meshes and test cases may modify these options, as noted below.
# The URL of the pull request documenting the creation of the mesh
pull_request = <<<Missing>>>
# Elevation threshold for including land cells
floodplain_elevation = 10.0
# config options related to dynamic adjustment
[dynamic_adjustment]
# the maximum allowed value of temperatureMax in global statistics
temperature_max = 33.0
# config options related to initial condition and diagnostics support files
# for E3SM
Expand Down Expand Up @@ -140,8 +148,8 @@ Note that meshes and test cases may modify these options, as noted below.
comparisonArcticStereoWidth = 6000.
comparisonArcticStereoResolution = 10.
The ``mesh_*``, ``init_*`` and ``forward:*`` config options are used to specify
the resources used in in the ``mesh`` step of the :ref:`global_ocean_mesh`,
The ``cull_mesh_*``, ``init_*`` and ``forward:*`` config options are used to
specify the resources used in in the ``mesh`` step of the :ref:`global_ocean_mesh`,
the ``initial_state`` step of the :ref:`global_ocean_init` and the
:ref:`global_ocean_forward`, respectively. These values will differ between
test cases and meshes.
Expand Down Expand Up @@ -378,7 +386,7 @@ options directly in ``namelist.ocean`` or modifying streams in
you can change in the config file for a test case. Since some test cases like
:ref:`global_ocean_restart_test` and :ref`global_ocean_dynamic_adjustment` have
more than one forward run, it is convenient to change options like
``forward_cores`` once in the config file, knowing that this will change the
``forward_ntasks`` once in the config file, knowing that this will change the
target number of cores of all forward model runs in the test case. The same
applies to the other ``forward_*`` config options that change the minimum cores
allowed, the number of threads, and (in the future) the maximum memory and disk
Expand Down

0 comments on commit db62191

Please sign in to comment.