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

Last UG updates #507

Merged
merged 7 commits into from
Sep 5, 2024
Merged

Last UG updates #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1a3bb72
fix chap_quick.rst that was not merged correctly from previous PR
grantfirl Aug 27, 2024
1d2f8c2
add info regarding the save_comp option in UFS_case_gen.py
grantfirl Aug 28, 2024
6ebd581
update chap_cases.rst
grantfirl Aug 28, 2024
a302767
add optional arguments for UFS_case_gen examples
grantfirl Aug 28, 2024
2ef6259
fix formatting error
grantfirl Aug 28, 2024
1e402c7
fix formatting error
grantfirl Aug 28, 2024
75f63b8
Merge branch 'release/public-v7' into update_ug_gjf
grantfirl Sep 5, 2024
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
36 changes: 31 additions & 5 deletions scm/doc/TechGuide/chap_cases.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,20 @@ Activate environment:
.. code:: bash

> conda activate env_ufscasegen

Note that it may be possible for conda to fail to solve for the environment when attempting to use the yml file. It
should still be possible to create the same environment manually:

.. code:: bash

> conda create --name env_ufscasegen
> conda install -n env_ufscasegen --channel=conda-forge python=3.8.5
> conda install -n env_ufscasegen --channel=conda-forge netcdf4
> conda install -n env_ufscasegen --channel=conda-forge f90nml
> conda install -n env_ufscasegen --channel=conda-forge xarray
> conda install -n env_ufscasegen --channel=conda-forge numpy
> conda install -n env_ufscasegen --channel=conda-forge shapely
> conda install -n env_ufscasegen --channel=conda-forge xesmf

.. _`ufscasegen`:

Expand Down Expand Up @@ -422,13 +436,24 @@ appreciably different than the calculated geostrophic winds), this often leads t
with time. An option exists within the script to assume that the mean three-dimensional winds are, in fact, identical to the
geostrophic winds as well. Using this option eliminates any spurious turning.

Writing UFS Comparison Data

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
`u`, `v`, `T`, and `q_v` are written out for the given point for each history file time. In addition, a collection of other
diagnostics like profiles of physics tendencies and scalar surface variables are saved and written. One can include any variable that is
provided in the UFS history files, although the specific variables are hard-coded in the `UFS_case_gen.py` file which will require editing
to change. The file with comparison data is automatically written out to the `scm/data/comparison_data` directory, although this is controlled
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
`--case_name (-n)` argument) and `_comp_data.nc`.

.. _`ufsforcingensemblegenerator`:

UFS_forcing_ensemble_generator.py
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. code:: bash

Expand Down Expand Up @@ -489,11 +514,12 @@ staged UWM RTs located at:
Example 1: UFS-caseGen for single point
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. code:: bash

./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
./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

Upon successful completion of the script, the command to run the case(s)
will print to the screen. For example,
Expand All @@ -509,11 +535,11 @@ The file ``scm_ufsens_control_c192.py`` is created in ``ccpp-scm/scm/bin/``, whe
Example 2: UFS-caseGen for list of points
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

UFS regression test, ``control_c384``, for multiple points.
UFS regression test, ``control_c384``, for multiple points assuming the same forcing method as above:

.. code:: bash

./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
./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

Upon successful completion of the script, the command to run the case(s)
will print to the screen. For example,
Expand Down
12 changes: 0 additions & 12 deletions scm/doc/TechGuide/chap_quick.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,13 +216,6 @@ Unified Forecast System and related applications, only a minority of which are r
install libraries manually if they wish, but they will need to make sure the appropriate environment variables
are set to the correct values so that the build system can find them, as described in the following paragraphs.


<<<<<<< HEAD
Setting up compilation environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For users on a pre-configured platform, the spack-stack environment can be loaded via one of the provided modules in ``scm/etc/modules/`` as described in :numref:`Section %s <use_preconfigured_platforms>`.
=======
For users on a pre-configured platform, you can load the spack-stack environment via one of the provided modules in ``scm/etc/modules/``.
For example, users on the NSF NCAR machine Derecho who wish to use Intel compilers can do the following:

Expand All @@ -231,7 +224,6 @@ For example, users on the NSF NCAR machine Derecho who wish to use Intel compile
cd [path/to/ccpp-scm/]
module use scm/etc/modules/
module load derecho_intel
>>>>>>> feature/modulefile_updates

Additionally, for users who have installed spack-stack on their own MacOS or Linux machine can use the provided ``macos_clang``
or ``linux_gnu`` modules.
Expand Down Expand Up @@ -613,11 +605,7 @@ configuration files located in ``../etc/case_config`` (*without the .nml extensi
specifying a suite other than the default, the suite name used must
match the value of the suite name in one of the suite definition files
located in ``../../ccpp/suites`` (Note: not the filename of the suite definition file). As
<<<<<<< HEAD
part of the CCPP SCM v7.0.0 release, the following suite names are supported:
=======
part of the seventh CCPP release, the following suite names are supported:
>>>>>>> feature/modulefile_updates

#. SCM_GFS_v16

Expand Down
Loading