Skip to content

Commit

Permalink
Merge branch 'main' into issue501
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanGregory authored Mar 10, 2024
2 parents 74ad7e2 + 20dca5b commit 46baeda
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 3 deletions.
12 changes: 9 additions & 3 deletions appb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,24 @@ Next is the **`standard_name_table`** itself, which is bracketed by the tags **`
The content (delimited by the `<standard_name_table>` tags) consists of, in order,

----
<version_number>Version number here ... </version_number>
<conventions>Conventions string here ... </conventions>
<last_modified>Datetime stamp here ... </last_modified>
<institution>Name of institution here ... </institution>
<contact>E-mail address of contact person ... </contact>
----

followed by a sequence of **`entry`** elements which may optionally be followed by a sequence of **`alias`** elements.
where the "Conventions string" is composed of the fixed string **`CF-StandardNameTable-`** immediately followed by the version number.

Next follows a sequence of **`entry`** elements which may optionally be followed by a sequence of **`alias`** elements.
The **`entry`** and **`alias`** elements take the following forms:

----
<entry id="an_id">
Define the variable whose standard_name attribute has the value "an_id".
</entry>
<alias id="another_id">
Provide alias for a variable whose standard_name attribute has the
value "another_id".
Provide alias for a variable whose standard_name attribute has the value "another_id".
</alias>
----

Expand Down Expand Up @@ -87,6 +91,8 @@ Each **`alias`** element contains a single element:
----
<?xml version="1.0"?>
<standard_name_table>
<version_number>83</version_number>
<conventions>CF-StandardNameTable-83</conventions>
<institution>Program for Climate Model Diagnosis and Intercomparison</institution>
<contact>[email protected]</contact>
<entry id="surface_air_pressure">
Expand Down
1 change: 1 addition & 0 deletions ch02.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ By the word _letters_ we mean the standard ASCII letters uppercase `A` to `Z` an
By the word _digits_ we mean the standard ASCII digits `0` to `9`, and similarly _underscores_ means the standard ASCII underscore `_`.
Note that this is in conformance with the COARDS conventions, but is more restrictive than the netCDF interface which allows almost all Unicode characters encoded as multibyte UTF-8 characters (link:$$https://docs.unidata.ucar.edu/nug/current/file_format_specifications.html$$[NUG Appendix B]).
The netCDF interface also allows leading underscores in names, but the NUG states that this is reserved for system use.
ASCII period (.) and ASCII hyphen (-) are also allowed in attribute names only.

Case is significant in netCDF names, but it is recommended that names should not be distinguished purely by case, i.e., if case is disregarded, no two names should be the same.
It is also recommended that names should be obviously meaningful, if possible, as this renders the file more effectively self-describing.
Expand Down
1 change: 1 addition & 0 deletions conformance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ See https://github.com/ugrid-conventions/ugrid-conventions for the UGRID conform
*Recommendations:*

* Variable, dimension and attribute names should begin with a letter and be composed of letters (A-Z, a-z), digits (0-9), and underscores(_). This corresponds to ASCII characters in the decimal ranges (65-90), (97-122), (48-57), and (95). The corresponding Unicode codepoints are (U+0041-U+005A), (U+0061-U+007A), (U+0030-U+0039), and (U+005F).
* ASCII period (.) and ASCII hyphen (-) may also be included in attribute names only.
* No two variable names should be identical when case is ignored.

[[section-2]]
Expand Down
2 changes: 2 additions & 0 deletions history.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
=== Working version (most recent first)

* {issues}501[Issue #501]: Clarify that data variables and variables containing coordinate data are highly recommended to have **`long_name`** or **`standard_name`** attributes, that **`cf_role`** is used only for discrete sampling geometries and UGRID mesh topologies, and that CF does not prohibit CF attributes from being used in ways that are not defined by CF but that in such cases their meaning is not defined by CF.
* {issues}477[Issue #477]: Period and hyphen allowed in attribute names
* {issues}500[Issue #500]: Appendix B: Added a **`conventions`** string to the standard name xml file format definition

=== Version 1.11 (05 December 2023)

Expand Down

0 comments on commit 46baeda

Please sign in to comment.