Attribute Conventions for Data Discovery 2.0

From Earth Science Information Partners (ESIP)
       DRAFT - Not ready for use

Version and Status

This version is designated as Version 2.0 This page always has the current version of the Attribute Convention for Data Discovery (ACDD). As it is updated, the version number at the top of the page will be updated.

See the [category page] for information on the history of this convention.

Development

Any development version of the ACDD definitions is maintained at Attribute_Convention_for_Data_Discovery_(ACDD)_Working.

Overview

The NetCDF Group at Unidata has recommended attributes for data discovery . The Attribute Convention for Data Discovery (ACDD) addresses that need, providing definitions for NetCDF global attributes that will help data to be located efficiently.

Alignment with NetCDF and CF Conventions

The NetCDF User Guide (NUG) provides basic recommendations for creating NetCDF files; the NetCDF Climate and Forecast Metadata Conventions (CF) provides more specific guidance. The ACDD builds upon and is compatible with these conventions; it may refine the definition of some terms in those conventions, but does not preclude the use of any attributes defined by the NUG or CF.

The NUG does not require any global attributes, though it recommends and defines two, title and history; CF specifies many more. ACDD 1.2 adopts all CF 1.6 global attributes with the exception of 'institution'; we specify 'creator_institution' and 'publisher_institution', to provide more provenance information. We also modify the syntax of the 'Conventions' attribute; we adopt the NUG recommendation to supply all conventions in a single attribute. This change has been approved by the CF Conventions Committee and will be part of CF 1.7, which is not yet published.

Attribute Crosswalks

Many of these attributes correspond to general discovery metadata content, so they are available in many metadata standards. This Unidata crosswalk to THREDDS page includes also includes a crosswalk to ISO 19115-2. Note that the attribute names link to the Unidata definitions. Many of these elements are included in the ISO 19115 Core specification. They are indicated in this Table by an M, O, or C in parentheses. An “M” indicates that the element is mandatory. An “O” indicates that the element is optional. A “C” indicates that the element is mandatory under certain conditions.

Additional Metadata: metadata_link attribute

Other metadata dialects (i.e. ISO 19115) can provide information about collections and more details about the dataset. If additional metadata exists, you can make users aware of it by adding a global attribute named "metadata_link" to the netCDF file. The value of this attribute is a URL that gives the location of the more complete metadata.


Maintenance of Metadata

ACDD attributes, like all NetCDF attributes, characterize their containing (parent) granules. As NetCDF data are processed (e.g., through subsetting or other algorithms), these characteristics can be altered. The software or user processor is responsible to update these attributes as part of the processing, but some software processes and user practices leave them unchanged. This affects both consumers and producers of these files, which comprises three roles:

  • developers of software tools that process NetCDF files;
  • users that create new NetCDF files from existing ones; and
  • end users of NetCDF files.

NetCDF file creators (the first two roles) should ensure that the attributes of output files accurately represent those files, and specifically should not "pass through" any source attribute in unaltered form, unless it is known to remain accurate. NetCDF file users (all three roles) should verify critical attribute values, and understand how the source data and metadata were generated, to be confident the source metadata is current.

The ACDD geospatiotemporal attributes present a special case, as this information is already fully defined by the CF coordinate variables (the redundant attributes are recommended to simplify access). Errors in these attributes will create an inconsistency between the metadata and data of the granule or file. The risk of these 'inconsistency errors' is highest for files that are aggregated into longer or larger products, or subset into shorter or smaller products, such as files from numerical forecast models and gridded satellite observations. For this reason, some providers of those data types may choose to omit the ACDD geospatiotemporal attributes from their files. If the ACDD geospatiotemporal attributes are present, checking them against the CF coordinate variables can serve as a partial test of the metadata's validity.


Metadata Link

The netCDF metadata model is focused on providing "use metadata" for the data included in the file (or granule). Other metadata dialects (i.e. ISO 19115) can provide information about collections and more details about the dataset. In order to make users aware of that additional metadata we recommend adding a global attribute named "Metadata_Link" to the netCDF file. The value of this attribute is a URL that gives the location of the more complete metadata. This element is not included in the current version of the NetCDF Attribute Convention for Dataset Discovery.

Global Attributes

Highly Recommended

Attribute Description THREDDS ISO 19115-2 OGC CSW Rubric Category
title
A short phrase or sentence describing the dataset; this is a NetCDF Users Guide (NUG) attribute. dataset@name
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString (M)
Title Text Search
summary
A paragraph describing the dataset, analogous to an abstract for a paper. metadata/documentation[@type="summary"]
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:abstract/gco:CharacterString (M)
Abstract Text Search
keywords
A comma-separated list of key words and/or phrases. Keywords may be common words or phrases, terms from a controlled vocabulary (GCMD is often used), or URIs for terms from a controlled vocabulary (see also keywords_vocabulary attribute). metadata/keyword
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:keyword/gco:CharacterString
Subject Text Search
Conventions A list of the conventions followed by the dataset; blank space separated is recommended but commas should be used if any convention name contains blanks. For files that comply with this version of ACDD, include the term ACDD-1.2. This attribute is defined in NUG.

Recommended