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.

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

Rename CCPP suites to non-meaningful names #2317

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[submodule "FV3"]
path = FV3
url = https://github.com/NOAA-EMC/fv3atm
branch = develop
url = https://github.com/mkavulich/fv3atm
branch = feature/suite_names_update
[submodule "WW3"]
path = WW3
url = https://github.com/NOAA-EMC/WW3
Expand Down
2 changes: 1 addition & 1 deletion FV3
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ The top level directory structure groups source code and input files as follow:
| ```tests/``` | Regression and unit testing framework scripts. |
| ```build.sh``` | Script to build the model executable (also used by `tests/`) |

E.g. use of `build.sh` to build the coupled model with `FV3_GFS_v15p2` as the CCPP suite.
E.g. use of `build.sh` to build the coupled model with `kingfisher` as the CCPP suite.
```
$> CMAKE_FLAGS="-DAPP=S2S" CCPP_SUITES="FV3_GFS_v15p2" ./build.sh
$> CMAKE_FLAGS="-DAPP=S2S" CCPP_SUITES="kingfisher" ./build.sh
```
The build system is regularly tested with [Tier-1 and Tier-2 platforms](
https://github.com/ufs-community/ufs-weather-model/wiki/Regression-Test-Policy-for-Weather-Model-Platforms-and-Compilers).
Expand Down
6 changes: 3 additions & 3 deletions doc/UsersGuide/source/BuildingAndRunning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ For the ``ufs-weather-model ATMAERO`` configuration (standalone ATM coupled to :

.. code-block:: console

export CMAKE_FLAGS="-DAPP=ATMAERO -DCCPP_SUITES=FV3_GFS_v17_p8"
export CMAKE_FLAGS="-DAPP=ATMAERO -DCCPP_SUITES=bluebird"

.. _atmaq:

Expand All @@ -286,7 +286,7 @@ For the ``ufs-weather-model ATMAQ`` configuration (standalone ATM coupled to :te

.. code-block:: console

export CMAKE_FLAGS="-DAPP=ATMAQ -DCCPP_SUITES=FV3_GFS_v15p2"
export CMAKE_FLAGS="-DAPP=ATMAQ -DCCPP_SUITES=kingfisher"

.. _atml:

Expand All @@ -296,7 +296,7 @@ For the ``ufs-weather-model ATML`` configuration (standalone ATM coupled to :ter

.. code-block:: console

export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=FV3_GFS_v17_p8"
export CMAKE_FLAGS="-DAPP=ATML -DCCPP_SUITES=bluebird"

S2S Configurations
----------------------
Expand Down
100 changes: 51 additions & 49 deletions doc/UsersGuide/source/Configurations.rst

Large diffs are not rendered by default.

20 changes: 15 additions & 5 deletions doc/UsersGuide/source/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,19 @@ The steps are:
cd tests

#. Find a configure (``*.conf``) file that contains the machine and compiler you are using. For this
example, the Intel compiler on Derecho is used. To create a custom configure file, two lines are
example, the test is being run on the Derecho machine. To create a custom configure file, two lines are
needed: a ``COMPILE`` line and a ``RUN`` line. The ``COMPILE`` line should contain the name
of the machine and compiler ``derecho.intel`` and the desired ``SUITES`` for the build. Choose a
of the machine``derecho`` and the desired ``SUITES`` for the build. Choose a
``RUN`` line under this ``COMPILE`` command that uses the desired ``SUITE``. For example:

.. code-block:: console

COMPILE | 32BIT=Y CCPP=Y STATIC=Y SUITES=FV3_GFS_v15p2,FV3_GFS_v16beta,FV3_GFS_v15p2_no_nsst,FV3_GFS_v16beta_no_nsst | standard | derecho.intel | fv3
RUN | fv3_ccpp_gfs_v16beta | standard | | fv3 |
COMPILE | atm_dyn32 | intel | -DAPP=ATM -DCCPP_SUITES=raven,bluebird,hummingbird -D32BIT=ON | | fv3 |
RUN | control_c192 | - derecho | baseline |


Put these two lines into a file called ``my_test.conf``. The parameters used in this run can be
found in the ``fv3_ccpp_gfs_v16beta`` file in the ``ufs-weather-model/tests/tests`` directory.
found in the ``control_c192`` file in the ``ufs-weather-model/tests/tests`` directory.

.. note:: These two lines are long and may not appear in entirety in your browser. Scroll to the right to see
the entire line.
Expand Down Expand Up @@ -571,3 +572,12 @@ For the fully coupled S2SWA application, a sample ``ufs.configure`` is shown bel
stop_option = nhours
stop_ymd = -999
::

=====================================================================
How can I run with the same physics as the operational GFS/HAFS/etc.?
=====================================================================

The UFS utilizes the Common Community Physics Package (CCPP) for its physics. This is a shared `software framework <https://github.com/NCAR/ccpp-framework>`_
and `repository of physics code <https://github.com/ufs-community/ccpp-physics>`_ used for sharing physics code among multiple different models and dynamical cores. The physics schemes that will be run depend on the :ref:`Suite Definition File (SDF) <SDF>`. However, using the same SDF is required to run the same physics, it is not sufficient. While we are working towards more unification in the future, for now physics settings are spread between both the SDF *and* the namelist :ref:`FV3 namelist "input.nml" <InputNML>`. So in order to run a simulation with the same physics as an operational product, or some other specific configuration, you will need to use both the same Suite Definition File **and** the same namelist settings. For the namelist settings available for each specific physics configuration, see the latest `CCPP Scientific Documentation <https://dtcenter.org/community-code/common-community-physics-package-ccpp/documentation>`_.


Loading