Skip to content

Update standard name rules with rules for units #21

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

Merged
climbfuji merged 4 commits into from
Aug 24, 2021
Merged

Update standard name rules with rules for units #21

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c65bc75
Update StandardNamesRules.rst
climbfuji Aug 23, 2021
175f7a3
Clarification of molar and volumetric mixing ratios
climbfuji Aug 23, 2021
6780fda
Update StandardNamesRules.rst
climbfuji Aug 24, 2021
59dee98
Fix table format and beef up hyperlink for SI units
climbfuji Aug 24, 2021
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
35 changes: 34 additions & 1 deletion StandardNamesRules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://cfconventions.org/standard-names.html>`_ unless
an appropriate name does not exist in that standard.
Expand Down Expand Up @@ -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 <https://cfconventions.org/standard-names.html>`_, 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) <https://www.nist.gov/pml/weights-and-measures/metric-si/si-units>`_

#. For dimensionless variables, the following units can be used:

+------------------------+-------------------------------------------------------------------------------------+
| **Unit** | **Use case** |
+========================+=====================================================================================+
| count | integers that describe the dimension/length of an array |
Copy link
Copy Markdown
Collaborator

@ligiabernardet ligiabernardet Aug 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table is not rendered correctly. Please use other tables as a template, and note that there must be a dashed line between each lines of the table.

Copy link
Copy Markdown
Collaborator Author

@climbfuji climbfuji Aug 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, should be ok now. I rendered it on my mac using rst2html.py StandardNamesRules.rst > StandardNamesRules.html and the results looked ok.

+------------------------+-------------------------------------------------------------------------------------+
| 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 |
Comment thread
climbfuji marked this conversation as resolved.
+------------------------+-------------------------------------------------------------------------------------+
| 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, ... |
+------------------------+-------------------------------------------------------------------------------------+