Skip to content

Commit 1d2f8c2

Browse files
committed
add info regarding the save_comp option in UFS_case_gen.py
1 parent 1a3bb72 commit 1d2f8c2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

scm/doc/TechGuide/chap_cases.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,16 @@ appreciably different than the calculated geostrophic winds), this often leads t
422422
with time. An option exists within the script to assume that the mean three-dimensional winds are, in fact, identical to the
423423
geostrophic winds as well. Using this option eliminates any spurious turning.
424424

425+
Writing UFS Comparison Data
426+
427+
The `--save_comp` (or `-sc`) options allow one to write out the UFS data for the chosen column in NetCDF format. The profiles of the state variables
428+
`u`, `v`, `T`, and `q_v` are written out for the given point for each history file time. In addition, a collection of other
429+
diagnostics like profiles of physics tendencies and scalar surface variables are saved and written. One can include any variable that is
430+
provided in the UFS history files, although the specific variables are hard-coded in the `UFS_case_gen.py` file which will require editing
431+
to change. The file with comparison data is automatically written out to the `scm/data/comparison_data` directory, although this is controlled
432+
by the `COMPARISON_DATA_DIR` global variable in the `UFS_case_gen.py` script. The filename is a concatenation of the case name (specified by the
433+
`--case_name (-n)` argument) and `_comp_data.nc`.
434+
425435
.. _`ufsforcingensemblegenerator`:
426436

427437
UFS_forcing_ensemble_generator.py

0 commit comments

Comments
 (0)