Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Documentation to clarify Namelist Inputs #888

Merged
merged 2 commits into from
Oct 18, 2023
Merged

Update Documentation to clarify Namelist Inputs #888

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdba2dc
Update Documentation to clarify Namelist Inputs
apcraig Oct 17, 2023
7494fce
Update documentation
apcraig Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions doc/source/cice_index.rst
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

.. _case_settings:

Case Settings
=====================
Model Namelist, CPPs, and Other Settings
==========================================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have one instance of the code itself referencing the "Case Settings" section of the documentation:

CICE/cicecore/cicedyn/general/ice_init.F90

Lines 1717 to 1720 in a5bb4f9

write(nu_diag,*) ' Overview of model configuration with relevant parameters'
write(nu_diag,*) '========================================================='
write(nu_diag,*) 'For details, compare namelist output below with the'
write(nu_diag,*) 'Case Settings section in the model documentation.'

So I think we should at least keep that as part of the section title, maybe something like:

 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
Expand Down Expand Up @@ -130,7 +130,7 @@ can be modified as needed.
.. _tabnamelist:


Table of namelist options
Tables of Namelist Inputs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I prefer "Options" to "Input".

-------------------------------

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