diff --git a/CCPPtechnical/source/ConstructingSuite.rst b/CCPPtechnical/source/ConstructingSuite.rst index 1aedeb1..db4ff7e 100644 --- a/CCPPtechnical/source/ConstructingSuite.rst +++ b/CCPPtechnical/source/ConstructingSuite.rst @@ -14,7 +14,21 @@ In addition to the :term:`primary parameterization ` 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 `_ 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 + + + + ... + ... -------------- Groups