Skip to content

Commit d54da13

Browse files
authored
Merge pull request #622 from davidhassell/main
New conventions documents and website updates for CF-1.13
2 parents 52b110f + fc97987 commit d54da13

File tree

8 files changed

+17115
-20
lines changed

8 files changed

+17115
-20
lines changed

Data/cf-conventions/cf-conventions-1.13/cf-conventions.html

Lines changed: 15295 additions & 0 deletions
Large diffs are not rendered by default.
6.66 MB
Binary file not shown.

Data/cf-documents/requirements-recommendations/conformance-1.13.html

Lines changed: 1793 additions & 0 deletions
Large diffs are not rendered by default.
Binary file not shown.

conventions.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,19 @@ group: "navigation"
1010
<div class="col-md-6">
1111
<h2>CF Conventions</h2>
1212
<p>
13-
<h4><b>Current working draft</b>: CF 1.13-draft</h4>
13+
<h4><b>Current working draft</b>: CF 1.14-draft</h4>
1414
<a href="/cf-conventions/cf-conventions.html">Single HTML</a>
1515
&nbsp;
1616
<a href="/cf-conventions/cf-conventions.pdf">PDF</a>
1717
&nbsp;
1818
19-
<h4><b>Latest released version</b>: CF 1.12 (December 2024)</h4>
19+
<h4><b>Latest released version</b>: CF 1.13 (December 2025)</h4>
20+
<a href="Data/cf-conventions/cf-conventions-1.13/cf-conventions.html">Single HTML</a>
21+
&nbsp;
22+
<a href="Data/cf-conventions/cf-conventions-1.13/cf-conventions.pdf">PDF</a>
23+
&nbsp;
24+
25+
<h4>CF 1.12 (December 2024)</h4>
2026
<a href="Data/cf-conventions/cf-conventions-1.12/cf-conventions.html">Single HTML</a>
2127
&nbsp;
2228
<a href="Data/cf-conventions/cf-conventions-1.12/cf-conventions.pdf">PDF</a>
@@ -109,7 +115,8 @@ group: "navigation"
109115
Each version of the CF conventions document is accompanied by a conformance document which lists the requirements and recommendations that could be verified by the compliance checker or any program with a similar aim. For any <em>recommendation</em> which is not followed, the checker gives a warning; for any <em>requirement</em> which is not met, it reports an error.
110116

111117
<p><ul>
112-
<li>1.13-draft: &nbsp; <a href="http://cfconventions.org/cf-conventions/conformance.pdf">PDF</a> &nbsp; <a href="http://cfconventions.org/cf-conventions/conformance.html">HTML</a></li>
118+
<li>1.14-draft: &nbsp; <a href="http://cfconventions.org/cf-conventions/conformance.pdf">PDF</a> &nbsp; <a href="http://cfconventions.org/cf-conventions/conformance.html">HTML</a></li>
119+
<li>1.13: &nbsp; <a href="Data/cf-documents/requirements-recommendations/conformance-1.13.pdf">PDF</a> &nbsp; <a href="Data/cf-documents/requirements-recommendations/conformance-1.13.html">HTML</a></li>
113120
<li>1.12: &nbsp; <a href="Data/cf-documents/requirements-recommendations/conformance-1.12.pdf">PDF</a> &nbsp; <a href="Data/cf-documents/requirements-recommendations/conformance-1.12.html">HTML</a></li>
114121
<li>1.11: &nbsp; <a href="Data/cf-documents/requirements-recommendations/conformance-1.11.pdf">PDF</a> &nbsp; <a href="Data/cf-documents/requirements-recommendations/conformance-1.11.html">HTML</a></li>
115122
<li><a href="Data/cf-documents/requirements-recommendations/conformance-1.10.html">1.10</a></li>

faq.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If you have a question that isn't on this list, please ask it of the CF-metadata
1111
We will use that list as the basis for additional content for this set of questions.
1212

1313
Note that many links in this FAQ point to previously released versions of the CF specification.
14-
However, others point to the currently-released CF-1.12 specification.
14+
However, others point to the currently-released CF-1.13 specification.
1515
This may provide better explanations or context, or more advanced capabilities.
1616
But generally these specifications do not conflict with one another, so there is no harm in following a link to a previous version.
1717

@@ -45,7 +45,7 @@ Many of the principles of CF operations follow the proposals at these [rules for
4545
### How long has CF been around? Is it mature?
4646

4747
Work began on CF in 2001 and [Version 1.0](/Data/cf-conventions/cf-conventions-1.0/build/cf-conventions.html) was released in October 2003.
48-
Now at Version 1.12, it has been used for tens of thousands of distinct netCDF products, continues to develop through [discussions][cf-discussion-page] involving hundreds of participants, and is a mature technical specification.
48+
Now at Version 1.13, it has been used for tens of thousands of distinct netCDF products, continues to develop through [discussions][cf-discussion-page] involving hundreds of participants, and is a mature technical specification.
4949
Because it is community-supported and community-driven, turnaround on questions and changes can take a little time, but are generally thoroughly considered.
5050

5151
### How does CF relate to other conventions/specifications (especially COARDS and netCDF)?
@@ -169,7 +169,7 @@ For example, `horizontal` is indicating a plane rather than a direction, while `
169169
### How can I encode flag values (or other enumerated lists) with CF?
170170

171171
Often data values in an enumerated list are given as string codes ("UP", "GOOD", "Warning"), yet it is more useful to encode these values as integers.
172-
CF's [flag_values mechanism](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#flags) can encode strings in numeric data variables, while defining flag_meanings to map the numbers to the meanings.
172+
CF's [flag_values mechanism](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#flags) can encode strings in numeric data variables, while defining flag_meanings to map the numbers to the meanings.
173173
The `flag_values` and `flag_meanings` attributes (and, if necessary, the `flag_masks` attribute) describe a status flag consisting of mutually exclusive coded values.
174174
The `flag_values` attribute is the same type as the variable to which it is attached, and contains a list of the possible flag values.
175175
The `flag_meanings` attribute is a string whose value is a blank-separated list of descriptive words or phrases, one for each flag value.
@@ -179,7 +179,7 @@ The `flag_meanings` attribute is a string whose value is a blank-separated list
179179
In NetCDF, a `coordinate variable` is a one-dimensional variable with the same name as its dimension [e.g., time(time)]; is a numeric data type; has values that are ordered monotonically (always going in one direction); and has no missing values.
180180
If you have a variable that contains coordinate values but does not meet these criteria, in CF you can still indicate that it has coordinate values by naming it as an auxiliary coordinate variable.
181181

182-
The rules for creating and using auxiliary coordinate variables are described in the [Coordinate Systems](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#coordinate-system) section of the Convention.
182+
The rules for creating and using auxiliary coordinate variables are described in the [Coordinate Systems](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#coordinate-system) section of the Convention.
183183

184184
## Rich technical questions about CF
185185
The detailed and big picture concepts in CF.
@@ -190,9 +190,9 @@ CF allows coordinate variables to be used for any quantity that you might regard
190190

191191
CF offers a rich set of options for specifying coordinate axes. Here is a short list of possibilities; others may be appropriate.
192192

193-
* [Discrete axes](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#discrete-axis) can have unordered, enumerated axis values, like days of the week or model levels [example](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#alternative-coordinates).
193+
* [Discrete axes](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#discrete-axis) can have unordered, enumerated axis values, like days of the week or model levels [example](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#alternative-coordinates).
194194
* Isotherms are described as a data variable of depth with a coordinate of (potential) temperature.
195-
* Various other vertical coordinate systems that are dimensionless are explicitly listed in [Appendix D](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#parametric-v-coord), and are specified as described in [Dimensionless Vertical Coordinates section](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#dimensionless-vertical-coordinate).
195+
* Various other vertical coordinate systems that are dimensionless are explicitly listed in [Appendix D](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#parametric-v-coord), and are specified as described in [Dimensionless Vertical Coordinates section](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#dimensionless-vertical-coordinate).
196196
* Swath coordinates (e.g., 'along-track' and 'across-track' values often obtained from platforms following a path, like satellites, planes, and autonomous underwater vehicles) can be expressed as x,y coordinates that are mapped to latitude and longitude. There are [open proposals](https://github.com/cf-convention/cf-conventions/issues/269) for specifying swath coordinates.
197197
* Degree-day integrals are described as integral_of_air_temperature_deficit|excess_wrt_time with a coordinate of air_temperature_threshold.
198198
* Electromagnetic radiation at particular wavelengths uses a coordinate of radiation_wavelength or radiation_frequency.
@@ -210,7 +210,7 @@ Very briefly, values in either or both of these axes may vary (a single run may
210210
If either axis contains just a single value, they are both specified as coordinates.
211211
If both are multi-valued, then they are each defined as one-dimensional auxiliary coordinate variables, with a common index dimension.
212212

213-
CF section 5.7 has an [example of the first case](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#scalar-coordinate-variables), with a scalar coordinate variable for forecast_reference_time and a multivalued time axis for the valid time.
213+
CF section 5.7 has an [example of the first case](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#scalar-coordinate-variables), with a scalar coordinate variable for forecast_reference_time and a multivalued time axis for the valid time.
214214

215215
An example of the second case can be found in the email referenced above.
216216

@@ -246,7 +246,7 @@ Use your good judgment!
246246

247247
CF maintains a vocabulary specifically for specifying surface and area types; it is available on the CF site as the [Area Type Table](/Data/area-type-table/current/build/area-type-table.html), and can also be accessed as a [controlled vocabulary](http://mmisw.org/ont/cf/areatype).
248248

249-
Terms from this vocabulary may be used as specified in the CF Convention [section 7.3.3 Statistics applying to portions of cells](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#statistics-applying-portions).
249+
Terms from this vocabulary may be used as specified in the CF Convention [section 7.3.3 Statistics applying to portions of cells](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#statistics-applying-portions).
250250
However, it is also possible to describe a data variable by using a named quantity as a coordinate variable, and the area_type is often needed for such a purpose.
251251
The area_type can be attached as a dimensioned coordinate variable, or as a scalar coordinate.
252252

@@ -300,7 +300,7 @@ surface_temperature:coordinates = "lat lon surface_type";
300300
## CF Standard Names
301301
General and specific information about purpose and mechanisms of standard names.
302302

303-
Reference [section 3.3 of the CF Convention, Standard Name](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#standard-name)
303+
Reference [section 3.3 of the CF Convention, Standard Name](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#standard-name)
304304

305305
### What is the official list of standard names?
306306

@@ -360,7 +360,7 @@ A CF standard name is a unique text string, which is associated in the CF Standa
360360
The text string is made up of two parts: the name (from the CF Standard Names table), and optionally, following the name and one or more blanks, a standard name modifier.
361361
The name contains no white space (underscores separate the words, in practice) and identifies the physical quantity.
362362
The modifier is used to describe a quantity which is related to another variable with the modified standard name.
363-
Details are provided in the convention section on [Standard Name](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#standard-name), and examples of modifiers are given in [Appendix C](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#standard-name-modifiers).
363+
Details are provided in the convention section on [Standard Name](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#standard-name), and examples of modifiers are given in [Appendix C](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#standard-name-modifiers).
364364

365365
Several attributes are required for every standard name: the canonical units, which are *typical* units of the physical quantity, and the description, which clarifies related quantities and meanings of the standard name (but is not strictly a definition per se).
366366
Older standard names may not have a description.
@@ -411,14 +411,14 @@ for | by | reported on | Artifact State
411411
The standard name should not include:
412412

413413
* provenance of the variable, including details of the process by which the value was obtained,
414-
* mathematical transformations such as addition, multiplication, and averaging (these are handled by [cell_methods](/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#cell-methods)),
414+
* mathematical transformations such as addition, multiplication, and averaging (these are handled by [cell_methods](/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#cell-methods)),
415415
* specialized terms not meaningful to a broad scientific audience, unless widely used and agreed on by the community of origin,
416416
* acronyms, or
417417
* geospatial location or similar deployment information, for example wind_speed_at_10_meter_platform.
418418

419419
In many cases the standard name is qualified by a specific detail, for example area_type, whose value may change from one set of observations to another or one observation to another.
420420
In these cases the definition for the standard name references one or more attributes or variables where the additional qualifying information may be found.
421-
([Standard name *modifiers*](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#standard-name-modifiers) and [cell_methods](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#cell-methods) may also be used for this purpose.)
421+
([Standard name *modifiers*](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#standard-name-modifiers) and [cell_methods](https://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#cell-methods) may also be used for this purpose.)
422422
In this way the divergence of the standard names is minimized, and interoperability increased.
423423

424424
### Are there common standard name phrases that get re-used?

index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ hero_gradient: to bottom, rgb(70, 110, 140), rgb(30, 70, 110)
88
hero_header: CF Metadata Conventions # Only displays if hero_image or hero_gradient are provided
99
#hero_paragraph: Some words about the CF Conventions # Only displays if hero_image or hero_gradient are provided
1010
hero_button_text: View latest release # Only displays if hero_image or hero_gradient are provided
11-
hero_button_url: Data/cf-conventions/cf-conventions-1.12/cf-conventions.html # Only displays if hero_image or hero_gradient are provided
11+
hero_button_url: Data/cf-conventions/cf-conventions-1.13/cf-conventions.html # Only displays if hero_image or hero_gradient are provided
1212
---
1313

1414
<br>
@@ -25,7 +25,7 @@ The use of CF is recommended where applicable by Unidata.
2525

2626
#### [Ask a question &#x2753; about how to use CF][github_askq]
2727

28-
### Latest release (1.12)
28+
### Latest release (1.13)
2929
[HTML][releasedhtml] [PDF][releasedpdf]
3030

3131
### Working draft
@@ -72,8 +72,8 @@ See also the links in the navigation bar at the top of this page.
7272
[discussion]: discussion.md
7373
[governance]: governance.md
7474
[faq]: faq.md
75-
[releasedhtml]: Data/cf-conventions/cf-conventions-1.12/cf-conventions.html
76-
[releasedpdf]: Data/cf-conventions/cf-conventions-1.12/cf-conventions.pdf
75+
[releasedhtml]: Data/cf-conventions/cf-conventions-1.13/cf-conventions.html
76+
[releasedpdf]: Data/cf-conventions/cf-conventions-1.13/cf-conventions.pdf
7777
[workinghtml]: /cf-conventions/cf-conventions.html
7878
[workingpdf]: /cf-conventions/cf-conventions.pdf
7979
[currentnames]: Data/cf-standard-names/current/build/cf-standard-name-table.html

software.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ See the [documentation](https://nco.sourceforge.net/nco.html) for a full descrip
8888

8989
### netCDF Flattener - Flatten netCDF files
9090

91-
The [netCDF Flattener](https://gitlab.eumetsat.int/open-source/netcdf-flattener/) Python package takes netCDF objects that use groups and flattens them while preserving references as described in the [Groups section](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#groups) of the CF Conventions.
91+
The [netCDF Flattener](https://gitlab.eumetsat.int/open-source/netcdf-flattener/) Python package takes netCDF objects that use groups and flattens them while preserving references as described in the [Groups section](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.13/cf-conventions.html#groups) of the CF Conventions.
9292
The resulting object is logically equivalent to the original, and can be processed by software that isn't able to work with files that use netCDF-4 groups.
9393

9494
### netCDF-Java Library

0 commit comments

Comments
 (0)