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

Clarify documentation associated with namelist inputs #470

Merged
merged 2 commits into from
Oct 18, 2023
Merged

Clarify documentation associated with namelist inputs #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3543ae9
Clarify documentation associated with namelist inputs
apcraig Oct 17, 2023
2774133
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
8 changes: 5 additions & 3 deletions doc/source/icepack_index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
Index of primary variables and parameters
==========================================

This index defines many of the symbols used frequently in the ice model
This index defines many (but not all) of the symbols used frequently in the ice model
code. Values appearing in this list are fixed or recommended; most
namelist parameters are indicated ( :math:`\bullet`) with their default
values. For other namelist options, see Section :ref:`tabnamelist`. All
quantities in the code are expressed in MKS units (temperatures may take
values. 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 of Icepack Variables and Parameters*
:header: " ", " ", " "
:widths: 15, 30, 15, 1
Expand Down
14 changes: 7 additions & 7 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
=====================
Case Settings, Model Namelist, and CPPs
====================================================

There are two important files that define the case, **icepack.settings** and
**icepack_in**. **icepack.settings** is a list of env variables that define many
Expand Down Expand Up @@ -115,8 +115,8 @@ can be modified as needed.

.. _tabnamelist:

Table of Namelist Inputs
--------------------------
Tables of Namelist Options
----------------------------

The Icepack driver reads a namelist input file, **icepack_in**, consisting of several namelist groups. The tables below
summarize the different groups and the variables in each group. The variables are organized alphabetically
Expand Down Expand Up @@ -344,6 +344,9 @@ forcing_nml
"``calc_strair``", "``.false.``", "read wind stress and speed from files", "``.true.``"
"", "``.true.``", "calculate wind stress and speed", ""
"``calc_Tsfc``", "logical", "calculate surface temperature", "``.true.``"
"``cpl_frazil``", "``external``", "frazil water/salt fluxes are handled outside of Icepack", "``fresh_ice_correction``"
"", "``fresh_ice_correction``", "correct fresh-ice frazil water/salt fluxes for mushy physics", ""
"", "``internal``", "send full frazil water/salt fluxes for mushy physics", ""
"``data_dir``", "string", "path to forcing data directory", "' '"
"``default_season``", "``summer``", "forcing initial summer values", "``winter``"
"", "``winter``", "forcing initial winter values", ""
Expand Down Expand Up @@ -378,9 +381,6 @@ forcing_nml
"", "``minus1p8``", "constant ocean freezing temperature (:math:`-1.8^{\circ} C`)", ""
"", "``mushy``", "matches mushy-layer thermo (ktherm=2)", ""
"``trestore``", "integer", "sst restoring time scale (days)", "90"
"``cpl_frazil``", "``external``", "frazil water/salt fluxes are handled outside of Icepack", "``fresh_ice_correction``"
"", "``fresh_ice_correction``", "correct fresh-ice frazil water/salt fluxes for mushy physics", ""
"", "``internal``", "send full frazil water/salt fluxes for mushy physics", ""
"``update_ocn_f``", "``.false.``", "do not include frazil water/salt fluxes in ocn fluxes", "``.false.``"
"", "``true``", "include frazil water/salt fluxes in ocn fluxes", ""
"``ustar_min``", "real", "minimum value of ocean friction velocity in m/s", "0.005"
Expand Down