diff --git a/StandardNamesRules.rst b/StandardNamesRules.rst index 3f0f14e..dc6daaa 100644 --- a/StandardNamesRules.rst +++ b/StandardNamesRules.rst @@ -14,13 +14,14 @@ for use with the Common Community Physics Package (CCPP). It describes the * Standard Name qualifiers * Other common standard name components * Acronyms, abbreviations, and aliases +* Units .. _Rules CCPP Standard Name Rules ======================== -#. Standard names should be identical to those from the la\ version +#. Standard names should be identical to those from the latest version of the `Climate and Forecast (CF) metadata conventions `_ unless an appropriate name does not exist in that standard. @@ -532,3 +533,35 @@ Acronyms, Abbreviations, and Aliases +---------------------+---------------------------------------------------------+ | wrt | with respect to | +---------------------+---------------------------------------------------------+ + +Units +===== + +#. For variables with an existing match in the `Climate and Forecast (CF) metadata + conventions `_, the units should + be identical to the canonical units listed there + +#. For variables without an existing match in the CF conventions, the units should + follow the `International System of Units (SI/metric system) `_ + +#. For dimensionless variables, the following units can be used: + ++------------------------+-------------------------------------------------------------------------------------+ +| **Unit** | **Use case** | ++========================+=====================================================================================+ +| count | integers that describe the dimension/length of an array | ++------------------------+-------------------------------------------------------------------------------------+ +| flag | logicals/booleans that can be either true or false | ++------------------------+-------------------------------------------------------------------------------------+ +| index | integers that can be an index in an array | ++------------------------+-------------------------------------------------------------------------------------+ +| kg kg-1 | mass mixing ratios | ++------------------------+-------------------------------------------------------------------------------------+ +| m3 m-3 | volume fraction (e.g. for soil moisture) | ++------------------------+-------------------------------------------------------------------------------------+ +| mol mol-1 | molar mixing ratios (also volumetric mixing ratio for gases) | ++------------------------+-------------------------------------------------------------------------------------+ +| none | strings and character arrays | ++------------------------+-------------------------------------------------------------------------------------+ +| 1 | any number (integer, real, complex), e.g. fractions, scaling factors, ... | ++------------------------+-------------------------------------------------------------------------------------+