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

Suite name guidelines #72

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Suite name guidelines #72

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4c94bb5
Add info about new suite naming guidelines
mkavulich May 20, 2024
e2c61b8
Some more detail on arbitrary nature of suite names
mkavulich May 22, 2024
12e0a6f
Add example of description comment and suite name tag
mkavulich May 22, 2024
f737d46
Fix formatting of example
mkavulich May 22, 2024
0f73b23
Avoid duplication, better wording about "guidelines" vs hard rules, t…
mkavulich May 22, 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
16 changes: 15 additions & 1 deletion CCPPtechnical/source/ConstructingSuite.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,21 @@ In addition to the :term:`primary parameterization <primary scheme>` categories

The format of the SDF is specified by a schema and all host models that use :term:`CCPP` include file ``suite.xsd`` to describe the schema.

The name of the suite is listed at the top of the SDF, right after the XML declaration, and must be consistent with the name of the SDF: file ``suite_ABC.xml`` contains ``suite name=’ABC’``, as in the example below. The suite name is followed by the version of the XML schema used.
The name of the suite is listed at the top of the SDF, right after the XML declaration, and must be consistent with the filename of the SDF: file ``ABC.xml`` must contain the tag ``suite name="ABC"``, as in the example below. The suite name is followed by the version of the XML schema used. There is no technical restriction on the names that a suite can have, but it is strongly recommended to avoid "self-descriptive" names; this avoids many problems with confusion about the contents and use of various suite files (see `this presentation <https://docs.google.com/presentation/d/1FYnos24J7URI-3Gw8dSc3FR_e4yZvJ7h/edit>`_ for further reasoning). For the UFS, a convention of bird names was arbitrarily adopted.

A suite file should also include a description as an xml comment; it is recommended that this description be as verbose as possible as to the reason why this particular set and order of schemes was selected. For example, if it was created for a particular operational prototype, used in a particular study, or (if a modified version of another suite), the reasoning for a specific modification.

.. code-block:: xml

> cat crossbill.xml
<?xml version="1.0" encoding="UTF-8"?>
<!--
DESCRIPTION:
Suite "crossbill" (formerly known as SCM_RRFS_v1nssl) was originally developed for research and development of early prototypes of the Rapid Refresh Forecast System (RRFS), specifically including the NSSL 2-moment cloud microphysics scheme when it was added to CCPP (see https://github.com/NOAA-EMC/fv3atm/pull/472 and https://github.com/NCAR/ccpp-physics/pull/761).
-->
<suite name="crossbill" version="1">
...
...

--------------
Groups
Expand Down