From fdba2dced7eb9683a686006ad9d8b4f0fa6ffb9b Mon Sep 17 00:00:00 2001 From: apcraig Date: Tue, 17 Oct 2023 15:36:16 -0600 Subject: [PATCH 1/2] Update Documentation to clarify Namelist Inputs --- 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 16f6ebe6f..04b0d7125 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 -===================== +Model Namelist, CPPs, and Other Settings +========================================== 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 Inputs ------------------------------- CICE reads a namelist input file, **ice_in**, consisting of several namelist groups. The tables below From 7494fceec2bcf65e6a8e43c0c3e45758c52f4428 Mon Sep 17 00:00:00 2001 From: apcraig Date: Wed, 18 Oct 2023 11:32:36 -0600 Subject: [PATCH 2/2] Update documentation --- doc/source/user_guide/ug_case_settings.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/ug_case_settings.rst b/doc/source/user_guide/ug_case_settings.rst index 04b0d7125..ac2c7ceb9 100644 --- a/doc/source/user_guide/ug_case_settings.rst +++ b/doc/source/user_guide/ug_case_settings.rst @@ -2,7 +2,7 @@ .. _case_settings: -Model Namelist, CPPs, and Other Settings +Case Settings, Model Namelist, and CPPs ========================================== There are two important files that define the case, **cice.settings** and @@ -130,7 +130,7 @@ can be modified as needed. .. _tabnamelist: -Tables of Namelist Inputs +Tables of Namelist Options ------------------------------- CICE reads a namelist input file, **ice_in**, consisting of several namelist groups. The tables below