From 496dbeb8a67ae21dcad6cb165550451c7588130a Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 16 Nov 2023 11:46:00 +0000 Subject: [PATCH] Auto-generated from cf-convention/cf-conventions@b83f0d3657823c87b5bf20cc263d8532e1f3fd48 --- cf-conventions.html | 183 ++++++++++++++++++++++---------------------- cf-conventions.pdf | Bin 6056906 -> 6057559 bytes conformance.html | 10 +-- conformance.pdf | Bin 333546 -> 333551 bytes 4 files changed, 98 insertions(+), 95 deletions(-) diff --git a/cf-conventions.html b/cf-conventions.html index 79732038..cfbe604b 100644 --- a/cf-conventions.html +++ b/cf-conventions.html @@ -1129,7 +1129,7 @@

1.3. Terminology<

The ascii format used to describe the contents of a netCDF file is called CDL (network Common Data form Language). This format represents arrays using the indexing conventions of the C programming language, i.e., index values start at 0, and in multidimensional arrays, when indexing over the elements of the array, it is the last declared dimension that is the fastest varying in terms of file storage order. The netCDF utilities ncdump and ncgen use this format (see -NUG section on CDL syntax). +NUG section on CDL syntax). All examples in this document use CDL syntax.

cell
@@ -1476,7 +1476,7 @@

2.5. Variables

2.5.1. Missing data, valid and actual range of data

The NUG conventions -(NUG Appendix A, Attribute Conventions) +(NUG Appendix A, Attribute Conventions) provide the _FillValue, missing_value, valid_min, valid_max, and valid_range attributes to indicate missing data. Missing data is allowed in data variables and auxiliary coordinate variables. Generic applications should treat the data as missing where any auxiliary coordinate variables have missing values; special-purpose applications might be able to make use of the data. @@ -1492,7 +1492,7 @@

2.5.1. Missing

The scalar attribute with the name _FillValue and of the same type as its variable is recognized by the netCDF library as the value used to pre-fill disk space allocated to the variable. This value is considered to be a special value that indicates undefined or missing data, and is returned when reading values that were not written. The _FillValue should be outside the range specified by valid_range (if used) for a variable. -The netCDF library defines a default fill value for each data type (See the "Note on fill values" in NUG Appendix B, File Format Specifications).

+The netCDF library defines a default fill value for each data type (See the "Note on fill values" in NUG Appendix B, File Format Specifications).

The missing values of a variable with scale_factor and/or add_offset attributes (see Section 8.1, "Packed Data") are interpreted relative to the variable’s external values (a.k.a. the packed values, the raw values, the values stored in the netCDF file), not the values that result after the scale and offset are applied. @@ -1530,7 +1530,7 @@

2.6. Attributes2.6.1. Identification of Conventions

Files that follow this version of the CF Conventions must indicate this by setting the NUG defined global attribute Conventions to a string value that contains "CF-1.11-draft". -The Conventions version number contained in that string can be used to find the web based versions of this document are from the netCDF Conventions web page. +The Conventions version number contained in that string can be used to find the web based versions of this document are from the netCDF Conventions web page. Subsequent versions of the CF Conventions will not make invalid a compliant usage of this or earlier versions of the CF terms and forms.

@@ -1960,11 +1960,11 @@

3.3. Standard

The standard name table is located at -http://cfconventions.org/Data/cf-standard-names/current/src/cf-standard-name-table.xml, +https://cfconventions.org/Data/cf-standard-names/current/src/cf-standard-name-table.xml, written in compliance with the XML format, as described in Appendix B, Standard Name Table Format. Knowledge of the XML format is only necessary for application writers who plan to directly access the table. A formatted text version of the table is provided at -http://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html, +https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html, and this table may be consulted in order to find the standard name that should be assigned to a variable. Some standard names (e.g. region and area_type) are used to indicate quantities which are permitted to take only certain standard values. This is indicated in the definition of the quantity in the standard name table, accompanied by a list or a link to a list of the permitted values.

@@ -2142,7 +2142,7 @@

3.5. Flags

A variable with standard name of region, area_type or any other standard name which requires string-valued values from a defined list may use flags together with flag_values and flag_meanings attributes to record the translation to the string values. -The following example illustrates this using integer flag values for a variable with standard name region and flag_values selected from the standardized region names (see section 6.1.1).

+The following example illustrates this using integer flag values for a variable with standard name region and flag_values selected from the standardized region names (see section 6.1.1).

Example 3.6. A region variable, using flag_values
@@ -3863,7 +3863,7 @@

6.1. Labels

6.1.1. Geographic Regions

When data is representative of geographic regions which can be identified by names but which have complex boundaries that cannot practically be specified using longitude and latitude boundary coordinates, a labeled axis should be used to identify the regions. -We recommend that the names be chosen from the list of standardized region names whenever possible. +We recommend that the names be chosen from the list of standardized region names whenever possible. To indicate that the label values are standardized the variable that contains the labels must be given the standard_name attribute with the value region.

@@ -3915,7 +3915,7 @@

@@ -6441,7 +6441,7 @@

App

add_offset

N

C, D

-

NUG Appendix A, "Attribute Conventions", and Section 8.1, "Packed Data"

+

NUG Appendix A, "Attribute Conventions", and Section 8.1, "Packed Data"

If present for a variable, this number is to be added to the data after it is read by an application. If both scale_factor and add_offset attributes are present, the data are first scaled before the offset is added. In cases where there is a strong constraint on dataset size, it is allowed to pack the coordinate variables (using add_offset and/or scale_factor), but this is not recommended in general.

@@ -6527,7 +6527,7 @@

App

Conventions

S

G

-

NUG Appendix A, "Attribute Conventions"

+

NUG Appendix A, "Attribute Conventions"

Name of the conventions followed by the dataset.

@@ -6562,7 +6562,7 @@

App

_FillValue

D

C, D

-

NUG Appendix A, "Attribute Conventions", and Section 2.5.1, "Missing data, valid and actual range of data", and Section 9.6, "Missing Data".

+

NUG Appendix A, "Attribute Conventions", and Section 2.5.1, "Missing data, valid and actual range of data", and Section 9.6, "Missing Data".

A value used to represent missing or undefined data. Allowed for auxiliary coordinate variables but not allowed for coordinate variables.

@@ -6628,7 +6628,7 @@

App

history

S

G, Gr

-

NUG Appendix A, "Attribute Conventions"

+

NUG Appendix A, "Attribute Conventions"

List of the applications that have modified the original data.

@@ -6686,7 +6686,7 @@

App

long_name

S

C, D, Do

-

NUG Appendix A, "Attribute Conventions", and Section 3.2, "Long Name"

+

NUG Appendix A, "Attribute Conventions", and Section 3.2, "Long Name"

A descriptive name that indicates a variable’s content. This name is not standardized.

@@ -6766,7 +6766,7 @@

App

scale_factor

N

C, D

-

NUG Appendix A, "Attribute Conventions", and Section 8.1, "Packed Data"

+

NUG Appendix A, "Attribute Conventions", and Section 8.1, "Packed Data"

If present for a variable, the data are to be multiplied by this factor after the data are read by an application. See also the add_offset attribute. In cases where there is a strong constraint on dataset size, it is allowed to pack the coordinate variables (using add_offset and/or scale_factor), but this is not recommended in general.

@@ -6796,35 +6796,35 @@

App

title

S

G, Gr

-

NUG Appendix A, "Attribute Conventions"

+

NUG Appendix A, "Attribute Conventions"

Short description of the file contents.

units

S

C, D

-

NUG Appendix A, "Attribute Conventions", and Section 3.1, "Units"

+

NUG Appendix A, "Attribute Conventions", and Section 3.1, "Units"

Units of a variable"s content.

valid_max

N

C, D

-

NUG Appendix A, "Attribute Conventions"

+

NUG Appendix A, "Attribute Conventions"

Largest valid value of a variable.

valid_min

N

C, D

-

NUG Appendix A, "Attribute Conventions"

+

NUG Appendix A, "Attribute Conventions"

Smallest valid value of a variable.

valid_range

N

C, D

-

NUG Appendix A, "Attribute Conventions"

+

NUG Appendix A, "Attribute Conventions"

Smallest and largest valid values of a variable.

@@ -6854,7 +6854,7 @@ 

<standard_name_table
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="CFStandardNameTable.xsd">

@@ -7831,7 +7831,7 @@

<

Notes on using the PROJ software package for computing the mapping may be found at http://geotiff.maptools.org/proj_list/azimuthal_equidistant.html and -https://proj.org/operations/projections/aeqd.html.

+https://proj.org/operations/projections/aeqd.html.

@@ -7889,11 +7889,11 @@

-

The algorithm for computing the mapping may be found at http://www.cgms-info.org/documents/pdf_cgms_03.pdf. +

The algorithm for computing the mapping may be found at https://www.cgms-info.org/documents/pdf_cgms_03.pdf. This document assumes the point of observation is directly over the equator, and that the sweep_angle_axis is y.

-

Explanatory diagrams for the projection may be found on the PROJ website, as well as notes on using the PROJ software for computing the mapping.

+

Explanatory diagrams for the projection may be found on the PROJ website, as well as notes on using the PROJ software for computing the mapping.

The perspective_point_height is the distance to the surface of the ellipsoid.

@@ -11865,6 +11865,9 @@

  • +

    Issue #463: Convert URLs with HTTP protocol to HTTPS if available, fixed a few dead links

    +
    • +

  • Issue #383: Link to the CF website and deleted the Preface section

  • @@ -12096,25 +12099,25 @@

    Pull request #146: Typos (plural dimensions) in section H

  • -

    Ticket #164: Add bounds attribute to first geometry CDL example.

    +

    Ticket #164: Add bounds attribute to first geometry CDL example.

  • -

    Ticket #164: Replace axis with bounds for coordinate variables related to geometry node variables.

    +

    Ticket #164: Replace axis with bounds for coordinate variables related to geometry node variables.

  • -

    Ticket #164: Add Tim Whiteaker and Dave Blodgett as authors.

    +

    Ticket #164: Add Tim Whiteaker and Dave Blodgett as authors.

  • -

    Ticket #164: Remove geometry attribute from lat/lon variables in examples.

    +

    Ticket #164: Remove geometry attribute from lat/lon variables in examples.

  • -

    Ticket #164: If coordinates attribute is carried by geometry container, require coordinate variables which correspond to node coordinate variables to have the corresponding axis attribute.

    +

    Ticket #164: If coordinates attribute is carried by geometry container, require coordinate variables which correspond to node coordinate variables to have the corresponding axis attribute.

  • -

    Ticket #164: Implement suggestions from trac ticket comments.

    +

    Ticket #164: Implement suggestions from trac ticket comments.

  • -

    Ticket #164: New Geometries section 7.5.

    +

    Ticket #164: New Geometries section 7.5.

@@ -12136,109 +12139,109 @@

Ticket #140: Added 3 paragraphs and an example to Chapter 7, Section 7.1.

+

Ticket #140: Added 3 paragraphs and an example to Chapter 7, Section 7.1.

  • -

    Ticket #100: Clarifications to the preamble of sections 4 and 5.

    +

    Ticket #100: Clarifications to the preamble of sections 4 and 5.

  • -

    Ticket #70: Connecting coordinates to Grid Mapping variables: revisions in Section 5.6 and Examples 5.10 and 5.12

    +

    Ticket #70: Connecting coordinates to Grid Mapping variables: revisions in Section 5.6 and Examples 5.10 and 5.12

  • -

    Ticket #104: Clarify the interpretation of scalar coordinate variables, changes in sections 5.7 and 6.1

    +

    Ticket #104: Clarify the interpretation of scalar coordinate variables, changes in sections 5.7 and 6.1

  • -

    Ticket #102: additional cell_methods, changes in Appendix E and section 7.3

    +

    Ticket #102: additional cell_methods, changes in Appendix E and section 7.3

  • -

    Ticket #80: added attributes to AppF Table F1, changes in section 5.6 and 5.6.1.

    +

    Ticket #80: added attributes to AppF Table F1, changes in section 5.6 and 5.6.1.

  • -

    Ticket #86: Allow coordinate variables to be scaled integers, affects two table rows in Appendix A.

    +

    Ticket #86: Allow coordinate variables to be scaled integers, affects two table rows in Appendix A.

  • -

    Ticket #138: Clarification of false_easting / false_northing (Table F.1)

    +

    Ticket #138: Clarification of false_easting / false_northing (Table F.1)

  • -

    Ticket #76: More than one name in Conventions attribute (section 2.6.1)

    +

    Ticket #76: More than one name in Conventions attribute (section 2.6.1)

  • -

    Ticket #109: resolve inconsistency of positive and standard_name attributes (section 4.3)

    +

    Ticket #109: resolve inconsistency of positive and standard_name attributes (section 4.3)

  • -

    Ticket #75: fix documentation and definitions of 3 grid mapping definitions

    +

    Ticket #75: fix documentation and definitions of 3 grid mapping definitions

  • -

    Ticket #143: Supplement the definitions of dimensionless vertical coordinates

    +

    Ticket #143: Supplement the definitions of dimensionless vertical coordinates

  • -

    Ticket #85: Added sentence to bottom of first para in Section 9.1 "Features and feature types". Added Links column in Section 9.1. Replaced first para in Section 9.6. "Missing Data". Added verbiage to Section 2.5.1, "Missing data…​". Added sentence to Appendix A "Description" "missing_value" and "Fill_Value".

    +

    Ticket #85: Added sentence to bottom of first para in Section 9.1 "Features and feature types". Added Links column in Section 9.1. Replaced first para in Section 9.6. "Missing Data". Added verbiage to Section 2.5.1, "Missing data…​". Added sentence to Appendix A "Description" "missing_value" and "Fill_Value".

  • -

    Ticket #145: Add new sentence to bottom of Section 7.2, Add new Section 2.6.3, "External variables". Add "External variable" attribute to Appendix A.

    +

    Ticket #145: Add new sentence to bottom of Section 7.2, Add new Section 2.6.3, "External variables". Add "External variable" attribute to Appendix A.

  • -

    Ticket #74: Removed "sea_water_speed" from flag values example and added Note at bottom of Example 3.3 in Chapter 3. Also added a sentence to Appendix C Standard Name Modifiers "number of observations" and and a sentence to "status_flag_modifiers"

    +

    Ticket #74: Removed "sea_water_speed" from flag values example and added Note at bottom of Example 3.3 in Chapter 3. Also added a sentence to Appendix C Standard Name Modifiers "number of observations" and and a sentence to "status_flag_modifiers"

  • -

    Ticket #103: Corrections to Appendices A and H, finish the ticket with remaining changes to Appendix H.

    +

    Ticket #103: Corrections to Appendices A and H, finish the ticket with remaining changes to Appendix H.

  • -

    Ticket #72: Adding the geostationary projection.

    +

    Ticket #72: Adding the geostationary projection.

  • -

    Ticket #92: Add oblique mercator projection

    +

    Ticket #92: Add oblique mercator projection

  • -

    Ticket #87: Allow comments in coordinate variables

    +

    Ticket #87: Allow comments in coordinate variables

  • -

    Ticket #77: Add sinusoidal projection

    +

    Ticket #77: Add sinusoidal projection

  • -

    Ticket #149: correction of standard name in example 7.3

    +

    Ticket #149: correction of standard name in example 7.3

  • -

    Ticket #148: Added maximum_absolute_value, minimum_absolute_value and mean_absolute_value to cell methods in Appendix E

    +

    Ticket #148: Added maximum_absolute_value, minimum_absolute_value and mean_absolute_value to cell methods in Appendix E

  • -

    Ticket #118: Add geoid_name and geopotential_datum_name to the list of Grid Mapping Attributes.

    +

    Ticket #118: Add geoid_name and geopotential_datum_name to the list of Grid Mapping Attributes.

  • -

    Ticket #123: revised section 3.3

    +

    Ticket #123: revised section 3.3

  • -

    Ticket #73: renamed Appendix G to Revision History

    +

    Ticket #73: renamed Appendix G to Revision History

  • -

    Ticket #31, add new attribute actual_range.

    +

    Ticket #31, add new attribute actual_range.

  • -

    Ticket #141, update affiliation organisations for Jonathan Gregory and Phil Bentley.

    +

    Ticket #141, update affiliation organisations for Jonathan Gregory and Phil Bentley.

  • -

    Ticket #103 updated Type and Use values for some attributes in Appendix A, Attributes and added "special purpose" value. In Appendix H, Annotated Examples of Discrete Geometries, updated coordinate values for the variables in some examples to correct omissions.

    +

    Ticket #103 updated Type and Use values for some attributes in Appendix A, Attributes and added "special purpose" value. In Appendix H, Annotated Examples of Discrete Geometries, updated coordinate values for the variables in some examples to correct omissions.

  • -

    Ticket #71, correction of Vertical perspective projection.

    +

    Ticket #71, correction of Vertical perspective projection.

  • -

    Ticket #67, remove deprecation of "missing_value" from Appendix A, Attributes.

    +

    Ticket #67, remove deprecation of "missing_value" from Appendix A, Attributes.

  • -

    Ticket #93: Added two new dimensionless coordinates to Appendix D.

    +

    Ticket #93: Added two new dimensionless coordinates to Appendix D.

  • Ticket #69. Added Section 5.6.1, Use of the CRS Well-known Text Format and related changes.

  • -

    Ticket #65: add range entry in Appendix E.

    +

    Ticket #65: add range entry in Appendix E.

  • -

    Ticket #64: section 7.3 editorial correction, replace "cell_bounds" with "bounds".

    +

    Ticket #64: section 7.3 editorial correction, replace "cell_bounds" with "bounds".

  • -

    Ticket #61: two new cell methods in Appendix E.

    +

    Ticket #61: two new cell methods in Appendix E.

    • @@ -12248,7 +12251,7 @@