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

adding CMIP variable documentation #195

Merged
merged 4 commits into from
Oct 5, 2018
Merged

adding CMIP variable documentation #195

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0d76fb6
adding CMIP variable documentation
duvivier Oct 1, 2018
146f9f2
updating references
duvivier Oct 2, 2018
f490819
cleaning up the documentation
duvivier Oct 2, 2018
843f9c9
fixing bibliography typos
duvivier Oct 2, 2018
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
2 changes: 1 addition & 1 deletion 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 @@ -354,7 +354,7 @@ Table of namelist options
"``trestore``", "integer", "sst restoring time scale (days)", ""
"``restore_ice``", "true/false", "restore ice state along lateral boundaries", ""
"", "", "", ""
"*icefields_tracer_nml*", "", "", ""
"*icefields_nml*", "", "", ""
"", "", "*History Fields*", ""
"``f_<var>``", "string", "frequency units for writing ``<var>`` to history", ""
"", "``y``", "write history every ``histfreq_n`` years", ""
Expand Down
23 changes: 18 additions & 5 deletions doc/source/user_guide/ug_implementation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,18 +743,21 @@ History files

Model output data is averaged over the period(s) given by `histfreq` and
`histfreq\_n`, and written to binary or  files prepended by `history\_file`
in **ice\_in**. That is, if `history\_file` = ‘iceh’ then the filenames
will have the form **iceh.[timeID].nc** or **iceh.[timeID].da**,
in **ice\_in**. These settings for history files are set in the
**setup\_nml** section of **ice\_in** (see :ref:`tabnamelist`).
If `history\_file` = ‘iceh’ then the
filenames will have the form **iceh.[timeID].nc** or **iceh.[timeID].da**,
depending on the output file format chosen in **comp\_ice** (set
`IO\_TYPE`). The  history files are CF-compliant; header information for
data contained in the  files is displayed with the command `ncdump -h
filename.nc`. Parallel  output is available using the PIO library; the
attribute `io\_flavor` distinguishes output files written with PIO from
those written with standard netCDF. With binary files, a separate header
file is written with equivalent information. Standard fields are output
according to settings in the **icefields\_nml** namelist in **ice\_in**.
according to settings in the **icefields\_nml** section of **ice\_in**
(see :ref:`tabnamelist`).
The user may add (or subtract) variables not already available in the
namelist by following the instructions in section :ref:`addhist`.
namelist by following the instructions in section :ref:`addhist`.

With this release, the history module has been divided into several
modules based on the desired formatting and on the variables
Expand All @@ -779,7 +782,7 @@ with a given `histfreq` value, or if an element of `histfreq\_n` is 0, then
no file will be written at that frequency. The output period can be
discerned from the filenames.

For example, in namelist:
For example, in the namelist:

::

Expand Down Expand Up @@ -832,6 +835,16 @@ another that is multiplied by :math:`a_i`, representing an average over
the grid cell area. Our naming convention attaches the suffix “\_ai" to
the grid-cell-mean variable names.

In this version of CICE, history variables requested by the Sea Ice Model Intercomparison
Project (SIMIP) have been added as possible history output variables (e.g.
`f_sithick`, `f_sidmassgrowthbottom`, etc.). A full list of SIMIP variables is
available at the following site
<https://earthsystemcog.org/projects/wip/CMIP6DataRequest>.
Additionally, a new history output variable, `f_CMIP`, has been added. When `f_CMIP`
is added to the **icefields\_nml** section of **ice\_in** then all SIMIP variables
will be turned on for output at the frequency specified by `f_CMIP`.


****************
Diagnostic files
****************
Expand Down