Skip to content

Commit a302767

Browse files
committed
add optional arguments for UFS_case_gen examples
1 parent 6ebd581 commit a302767

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

scm/doc/TechGuide/chap_cases.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,8 @@ UFS_forcing_ensemble_generator.py
453453
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
454454

455455
There is an additional script in ``scm/etc/scripts/UFS_forcing_ensemble_generator.py`` to create UFS-caseGen case(s) starting
456-
with output from UFS Weather Model (UWM) Regression Tests (RTs).
456+
with output from UFS Weather Model (UWM) Regression Tests (RTs). This script provides a wrapper for ``UFS_case_gen.py`` for
457+
generating multiple cases at once.
457458

458459
.. code:: bash
459460
@@ -514,11 +515,12 @@ staged UWM RTs located at:
514515
Example 1: UFS-caseGen for single point
515516
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
516517

517-
UFS regression test, ``control_c192``, for single point.
518+
UFS regression test, ``control_c192``, for a single point using calculated horizontal advective tendencies,
519+
supplying the vertical velocity for the vertical advective terms and nudging the horizontal winds:
518520

519521
.. code:: bash
520522
521-
./UFS_forcing_ensemble_generator.py -d [path_to_regression_tests_output]/control_c192_intel/ -sc --C_RES 192 -dt 360 -n control_c192 -lons 300 -lats 34
523+
./UFS_forcing_ensemble_generator.py -d [path_to_regression_tests_output]/control_c192_intel/ -sc --C_RES 192 -dt 360 -n control_c192 -lons 300 -lats 34 -fm 2 -vm 2 -wn
522524
523525
Upon successful completion of the script, the command to run the case(s)
524526
will print to the screen. For example,
@@ -534,11 +536,11 @@ The file ``scm_ufsens_control_c192.py`` is created in ``ccpp-scm/scm/bin/``, whe
534536
Example 2: UFS-caseGen for list of points
535537
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
536538

537-
UFS regression test, ``control_c384``, for multiple points.
539+
UFS regression test, ``control_c384``, for multiple points assuming the same forcing method as above:
538540

539541
.. code:: bash
540542
541-
./UFS_forcing_ensemble_generator.py -d /glade/derecho/scratch/epicufsrt/ufs-weather-model/RT/NEMSfv3gfs/develop-20240607/control_c384_intel/ -sc --C_RES 384 -dt 225 -n control_c384 -lons 300 300 300 300 -lats 34 35 35 37
543+
./UFS_forcing_ensemble_generator.py -d /glade/derecho/scratch/epicufsrt/ufs-weather-model/RT/NEMSfv3gfs/develop-20240607/control_c384_intel/ -sc --C_RES 384 -dt 225 -n control_c384 -lons 300 300 300 300 -lats 34 35 35 37 -fm 2 -vm 2 -wn
542544
543545
Upon successful completion of the script, the command to run the case(s)
544546
will print to the screen. For example,

0 commit comments

Comments
 (0)