Skip to content

Commit

Permalink
Update Documentation to clarify Namelist Inputs (CICE-Consortium#888)
Browse files Browse the repository at this point in the history
* Update Documentation to clarify Namelist Inputs

* Update documentation
  • Loading branch information
apcraig committed Oct 18, 2023
1 parent a9d6dc7 commit 6ba070f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
9 changes: 5 additions & 4 deletions doc/source/cice_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
Index of primary variables and parameters
==========================================

This index defines many of the symbols used frequently in the CICE model
code. Namelist variables are partly included here but also documented
elsewhere, see Section :ref:`tabnamelist`. All
quantities in the code are expressed in MKS units (temperatures may take
This index defines many (but not all) of the symbols used frequently in the CICE model
code. All quantities in the code are expressed in MKS units (temperatures may take
either Celsius or Kelvin units). Deprecated parameters are listed at the end.

Namelist variables are partly included here, but they are fully documented in
section :ref:`tabnamelist`.

.. csv-table:: *Alphabetical Index*
:header: " ", " ", " "
:widths: 15, 30, 15, 1
Expand Down
6 changes: 3 additions & 3 deletions doc/source/user_guide/ug_case_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

.. _case_settings:

Case Settings
=====================
Case Settings, Model Namelist, and CPPs
==========================================

There are two important files that define the case, **cice.settings** and
**ice_in**. **cice.settings** is a list of env variables that define many
Expand Down Expand Up @@ -130,7 +130,7 @@ can be modified as needed.
.. _tabnamelist:


Table of namelist options
Tables of Namelist Options
-------------------------------

CICE reads a namelist input file, **ice_in**, consisting of several namelist groups. The tables below
Expand Down

0 comments on commit 6ba070f

Please sign in to comment.