From 6ba070f7e7027f9fd2cc32f2dbe10c9854511d93 Mon Sep 17 00:00:00 2001 From: Tony Craig Date: Wed, 18 Oct 2023 12:35:08 -0700 Subject: [PATCH] Update Documentation to clarify Namelist Inputs (#888) * Update Documentation to clarify Namelist Inputs * Update documentation --- doc/source/cice_index.rst | 9 +++++---- doc/source/user_guide/ug_case_settings.rst | 6 +++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/source/cice_index.rst b/doc/source/cice_index.rst index 4a48d2a62..7878b2f5e 100644 --- a/doc/source/cice_index.rst +++ b/doc/source/cice_index.rst @@ -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 diff --git a/doc/source/user_guide/ug_case_settings.rst b/doc/source/user_guide/ug_case_settings.rst index 09145eeab..ebb33b65e 100644 --- a/doc/source/user_guide/ug_case_settings.rst +++ b/doc/source/user_guide/ug_case_settings.rst @@ -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 @@ -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