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

Update StandardNamesRules.rst: changesurface prefix to _at_surface suffix #72

Merged
merged 4 commits into from
Sep 27, 2024
Merged
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
17 changes: 11 additions & 6 deletions StandardNamesRules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ CCPP Standard Name Rules
#. 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.
an appropriate name does not exist in that standard, or the adoption
of said names leads to inconsistencies in the naming convention.

#. When a standard name doesn’t exist in the CF conventions, follow their
#. When no suitable standard name exists in the CF conventions, follow their
guidelines for standard name construction at this URL:
http://cfconventions.org/Data/cf-standard-names/docs/guidelines.html. Standard
names may be qualified by the addition of phrases in certain standard forms and
Expand All @@ -42,7 +43,7 @@ CCPP Standard Name Rules
words or phrases to be substituted. The new standard name is constructed by
joining the base standard name to the qualifiers using underscores.

[``surface``] [``component``] standard_name [*at* ``surface``] [*in* ``medium``]
[``component``] standard_name [*at* ``level``] [*in* ``medium``]
[*due_to* ``process``] [*assuming* ``condition``]

See the list of currently-used qualifiers below for help.
Expand Down Expand Up @@ -152,9 +153,10 @@ XY-surface
Prefixes
^^^^^^^^

| toa
| tropopause
| surface
None. Note that this is a departure from the CF conventions, which in
many cases - but not all - use surface_ as a prefix. This departure from
the CF convention is to maintain consistency with all other level
qualifiers that are used as _at_level-qualifier (i.e. as suffix).

Suffixes
^^^^^^^^
Expand All @@ -173,6 +175,9 @@ Suffixes
| at_top_of_atmosphere_model
| at_top_of_dry_convection
| **at_interfaces**
| **at_toa**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a difference between "toa" (defined as "top of atmosphere") and "top of atmosphere model"?

This may be worthy of a separate discussion, if so I won't hold up this PR but we can address it later.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If that question is directed to me than I don't have a definitive answer for you, sorry.

| **at_tropopause**
| **at_surface**
| **at_surface_adjacent_layer**
| **at_2m**
| **at_10m**
Expand Down
Loading