|
|
| (14 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | <font color="red">'''DRAFT - Not ready for use'''</font>
| + | RESERVED FOR FUTURE VERSION. |
| − | == Version and Status ==
| + | The most recent version (still in draft) is [[Attribute_Convention_for_Data_Discovery_1.3|ACDD 1.3]] |
| − | 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 [[http://wiki.esipfed.org/index.php/Category:Attribute_Conventions_Dataset_Discovery 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 =
| |
| − | This document describes attributes recommended for describing a NetCDF dataset to discovery systems such as Digital Libraries. THREDDS and other tools can use these attributes for extracting metadata from datasets, and exporting to Dublin Core, DIF, ADN, FGDC, ISO 19115 and other metadata formats. This will help systems and users locate and use data efficiently.
| |
| − | | |
| − | == Alignment with NetCDF and CF Conventions ==
| |
| − | The NetCDF User Guide [http://www.unidata.ucar.edu/software/netcdf/docs/netcdf.html (NUG)] provides basic recommendations for creating NetCDF files; the NetCDF Climate and Forecast Metadata Conventions [http://cf-pcmdi.llnl.gov/documents/cf-conventions/latest-cf-conventions-document-1/ (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 2.0 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 [[Attribute_Convention_for_Data_Discovery_(ACDD)_Mappings]] page includes a crosswalk to THREDDS, OGC CSW, ISO 19115-2 and Rubric Categories.
| |
| − | | |
| − | == Additional Metadata: metadata_link attribute ==
| |
| − | 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. 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.
| |
| − | | |
| − | <!--''{(Not for inclusion in final draft) As a working tool, the page [[NetCDF Utilities Metadata Handling]] has been created to identify the state of play for how tools handle metadata attributes when processing files.}''-->
| |
| − | | |
| − | = Global Attributes =
| |
| − | == Highly Recommended ==
| |
| − | <table width="95%" border="1" cellpadding="2" cellspacing="2">
| |
| − | <tr>
| |
| − | <th valign="top" width="200px">Attribute</th>
| |
| − | <th valign="top">Description</th>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">title</td>
| |
| − | <td valign="top">A short phrase or sentence describing the dataset. Its value will be used by THREDDS as the name of the dataset and therefore should be human readable and reasonable to display in a list of such names. The "title" attribute is also recommended by the NetCDF Users Guide ([http://www.unidata.ucar.edu/software/netcdf/docs/netcdf.html#Attribute-Conventions NUG]) and the [http://cfconventions.org/ CF conventions].
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">summary</td>
| |
| − | <td valign="top">A paragraph describing the dataset, analogous to an abstract for a paper. In many discovery systems, the title and the summary will be displayed in the results list from a search. It should therefore capture the essence of the dataset it describes. For instance, we recommend a summary of the following: type of data contained in the dataset, how the data was created (e.g., instrument X; or model X, run Y), the creator of the dataset, the project for which the data was created, the geospatial coverage of the data, and the temporal coverage of the data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">keywords</td>
| |
| − | <td valign="top">A comma-separated list of key words and/or phrases. Keywords may be common words or phrases, terms from a controlled vocabulary ([http://gcmd.gsfc.nasa.gov/learn/keywords.html GCMD] is often used), or URIs for terms from a controlled vocabulary (see also keywords_vocabulary attribute).</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">Conventions</td>
| |
| − | <td valign="top">A list of the conventions followed by the dataset; <font color="red">blank space separated is recommended but commas should be used if any convention name contains blanks</font>. For files that comply with this version of ACDD, include the term ACDD-2.0. This attribute is defined in [http://www.unidata.ucar.edu/software/netcdf/docs/netcdf.html#Attribute-Conventions NUG].</td>
| |
| − | </tr>
| |
| − | </table>
| |
| − | | |
| − | ==Recommended==
| |
| − | <table width="95%" border="1" cellpadding="2" cellspacing="2">
| |
| − | <tr>
| |
| − | <th valign="top" width="200px">Attribute</th>
| |
| − | <th valign="top">Description</th>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">contributor_info</td>
| |
| − | <td valign="top">The name and role of any individuals, projects, or institutions that contributed to the creation of this data. May be presented as free text, or in a structured format compatible with conversion to ncML (e.g., insensitive to whitespace).</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">date_product_available</td>
| |
| − | <td valign="top">The date on which this data file or product was produced or distributed. Use [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] date format. While this date is like a file timestamp, the date_product_modified and date_values_modified should be used to assess the age of the contents of the file or product.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lat_units</td>
| |
| − | <td valign="top">Units for the latitude axis <font color="green">described in "geospatial_lat_min" and "geospatial_lat_max" attributes</font>. These are presumed to be "degree_north"; other options from udunits may be specified instead.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lat_resolution</td>
| |
| − | <td valign="top">Information about the targeted spacing of points in latitude. <font color="red">(Format is not prescribed.)</font></td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lon_units</td>
| |
| − | <td valign="top">Units for the longitude axis <font color="green">described in "geospatial_lon_min" and "geospatial_lon_max" attributes.</font> These are presumed to be "degree_east"; other options from udunits may be specified instead.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lon_resolution</td>
| |
| − | <td valign="top">Information about the targeted spacing of points in longitude. <font color="red">(Format is not prescribed.)</font></td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_vertical_units</td>
| |
| − | <td valign="top">Units for the vertical axis <font color="green">described in "geospatial_vertical_min" and "geospatial_vertical_max" attributes</font>. These are presumed to be "meter" (of depth); other options from udunits may be specified. Note that the common oceanographic practice of using pressure for a vertical coordinate, while not strictly a depth, can be specified using the unit bar.</td>
| |
| − | <!--<td valign="top" rowspan="3">/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:extent/gmd:EX_Extent/gmd:verticalElement/gmd:EX_VerticalExtent/gmd:verticalCRS</td> <td></td> <td>Extent</td>-->
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_vertical_resolution</td>
| |
| − | <td valign="top">Information about the targeted vertical spacing of points.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_uri</td>
| |
| − | <td valign="top">The unique identifier of the person principally responsible for originating this data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_institution</td>
| |
| − | <td valign="top">The institution that originated this data; should uniquely identify the institution.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_institution_info</td>
| |
| − | <td valign="top">Additional free text information for the institution that originated this data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_project</td>
| |
| − | <td valign="top">The scientific project that originated this data; should uniquely identify the project.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_project_info</td>
| |
| − | <td valign="top">Additional free text information for the institution that originated this data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_uri</td>
| |
| − | <td valign="top">The unique identifier of the person responsible for providing the data file or product.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_institution</td>
| |
| − | <td valign="top">The institution that provided the data file or equivalent product; should uniquely identify the institution.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_institution_info</td>
| |
| − | <td valign="top">Additional information for the institution that provided the data file or equivalent product; can include any information as free text, <font color="red">or in a structured format compatible with conversion to ncML (e.g., insensitive to whitespace)</font>.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_project</td>
| |
| − | <td valign="top">The scientific project that provided the data file or equivalent product; should uniquely identify the project.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_project_info</td>
| |
| − | <td valign="top">Additional information for the institution that provided the data file or equivalent product; can include any information as free text, <font color="red">or in a structured format compatible with conversion to ncML (e.g., insensitive to whitespace)</font>.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">keywords_vocabulary</td>
| |
| − | <td valign="top">If you are using a controlled vocabulary for the words/phrases in your "keywords" attribute, this is the unique name or identifier of the vocabulary from which keywords are taken. If more than one keyword vocabulary is used, <font color="red">each may be presented with a prefix (e.g., "CF:NetCDF COARDS Climate and Forecast Standard Names") and a following comma, so that keywords may optionally be prefixed with the controlled vocabulary key.</font></td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">metadata_link</td>
| |
| − | <td valign="top">A URI that gives the location of more complete metadata; a URL is recommended.</td>
| |
| − | </tr>
| |
| − | </table>
| |
| − | | |
| − | ==Suggested==
| |
| − | <table width="95%" border="1" cellpadding="2" cellspacing="2">
| |
| − | <tr>
| |
| − | <th valign="top" width="200px">Attribute</th>
| |
| − | <th valign="top">Description</th>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">contributor_info</td>
| |
| − | <td valign="top">The name and role of any individuals, projects, or institutions that contributed to the creation of this data. May be presented as free text, or in a structured format compatible with conversion to ncML (e.g., insensitive to whitespace).</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">date_product_available</td>
| |
| − | <td valign="top">The date on which this data file or product was produced or distributed. Use [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] date format. While this date is like a file timestamp, the date_product_modified and date_values_modified should be used to assess the age of the contents of the file or product.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lat_units</td>
| |
| − | <td valign="top">Units for the latitude axis <font color="green">described in "geospatial_lat_min" and "geospatial_lat_max" attributes</font>. These are presumed to be "degree_north"; other options from udunits may be specified instead.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lat_resolution</td>
| |
| − | <td valign="top">Information about the targeted spacing of points in latitude. <font color="red">(Format is not prescribed.)</font></td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lon_units</td>
| |
| − | <td valign="top">Units for the longitude axis <font color="green">described in "geospatial_lon_min" and "geospatial_lon_max" attributes.</font> These are presumed to be "degree_east"; other options from udunits may be specified instead.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_lon_resolution</td>
| |
| − | <td valign="top">Information about the targeted spacing of points in longitude. <font color="red">(Format is not prescribed.)</font></td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_vertical_units</td>
| |
| − | <td valign="top">Units for the vertical axis <font color="green">described in "geospatial_vertical_min" and "geospatial_vertical_max" attributes</font>. These are presumed to be "meter" (of depth); other options from udunits may be specified. Note that the common oceanographic practice of using pressure for a vertical coordinate, while not strictly a depth, can be specified using the unit bar.</td>
| |
| − | <!--<td valign="top" rowspan="3">/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:extent/gmd:EX_Extent/gmd:verticalElement/gmd:EX_VerticalExtent/gmd:verticalCRS</td> <td></td> <td>Extent</td>-->
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">geospatial_vertical_resolution</td>
| |
| − | <td valign="top">Information about the targeted vertical spacing of points.</td>
| |
| − | </tr>
| |
| − |
| |
| − | <tr>
| |
| − | <td valign="top">creator_uri</td>
| |
| − | <td valign="top">The unique identifier of the person principally responsible for originating this data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_institution</td>
| |
| − | <td valign="top">The institution that originated this data; should uniquely identify the institution.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_institution_info</td>
| |
| − | <td valign="top">Additional free text information for the institution that originated this data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_project</td>
| |
| − | <td valign="top">The scientific project that originated this data; should uniquely identify the project.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">creator_project_info</td>
| |
| − | <td valign="top">Additional free text information for the institution that originated this data.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_uri</td>
| |
| − | <td valign="top">The unique identifier of the person responsible for providing the data file or product.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_institution</td>
| |
| − | <td valign="top">The institution that provided the data file or equivalent product; should uniquely identify the institution.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_institution_info</td>
| |
| − | <td valign="top">Additional information for the institution that provided the data file or equivalent product; can include any information as free text, <font color="red">or in a structured format compatible with conversion to ncML (e.g., insensitive to whitespace)</font>.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_project</td>
| |
| − | <td valign="top">The scientific project that provided the data file or equivalent product; should uniquely identify the project.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">publisher_project_info</td>
| |
| − | <td valign="top">Additional information for the institution that provided the data file or equivalent product; can include any information as free text, <font color="red">or in a structured format compatible with conversion to ncML (e.g., insensitive to whitespace)</font>.</td>
| |
| − | </tr>
| |
| − | <!-- START HERE -->
| |
| − | <tr>
| |
| − | <td valign="top">keywords_vocabulary</td>
| |
| − | <td valign="top">If you are using a controlled vocabulary for the words/phrases in your "keywords" attribute, this is the unique name or identifier of the vocabulary from which keywords are taken. If more than one keyword vocabulary is used, each may be presented with a prefix (e.g., "CF:NetCDF COARDS Climate and Forecast Standard Names") and a following comma, so that keywords may optionally be prefixed with the controlled vocabulary key.</td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign="top">metadata_link</td>
| |
| − | <td valign="top">A URI that gives the location of more complete metadata; a URL is recommended.</td>
| |
| − | </tr>
| |
| − | </table>
| |
| − | | |
| − | ==Highly Recommended Variable Attributes==
| |
| − | <table width="95%" border="1" cellpadding="2" cellspacing="2">
| |
| − | <tr>
| |
| − | <th valign="top" width="200px">Attribute</th>
| |
| − | <th valign="top">Description</th>
| |
| − | <tr>
| |
| − | <td valign="top">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#long_name_Attribute long_name]</td>
| |
| − | <td valign="top">A long descriptive name for the variable (not necessarily from a controlled vocabulary).</td>
| |
| − | <tr>
| |
| − | <td valign="top">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#standard_name_Attribute standard_name]<br></td>
| |
| − | <tr>
| |
| − | <td valign="top">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#units_Attribute units]</td>
| |
| − | <td valign="top">The units of the variables data values. This attributes value should be a valid udunits string.</td>
| |
| − | <tr>
| |
| − | <td valign="top">coverage_content_type</td>
| |
| − | <td valign="top">An ISO 19115-1 code to indicate the source of the data.</td>
| |
| − | </table>
| |
| − | | |
| − | == Deprecated ==
| |
| − | The following terms and definitions are still recognized, but are no longer recommended for use by ACDD.
| |
| − | | |
| − | : Metadata_Convention: removed in favor of 'Conventions'
| |
| − | : date_created: deleted (use cases are addressed by 'date_product_available')
| |
| − | : date_issued: deleted in favor of 'date_product_available'
| |
| − | : date_modified: deleted in favor of 'date_product_modified' and 'date_values_modified'
| |
| − | : institution: though recommended by CF, removed in favor more detailed attributes - 'creator_institution', 'creator_institution_info', 'publisher_institution', 'publisher_institution_info' to provide more provenance information
| |
| − | ----
| |
| − | | |
| − | === Conformance Test ===
| |
| − | Conformance tests are available for verson 1.1. We hope to make a conformance test for this version available.
| |
| − | | |
| − | = Additional Materials =
| |
| − | These materials are not normative and may not be in alignment with this version of ACDD.
| |
| − | | |
| − | == Mappings ACDD to other metadata dialects ==
| |
| − | [[Attribute Convention for Data Discovery (ACDD) Mappings]]-
| |
| − | | |
| − | == Recommended Order of Precedence ==
| |
| − | [[Attribute Convention for Data Discovery (ACDD) Precedence]]
| |
| − | | |
| − | == Future Directions: Object Conventions for Data Discovery ==
| |
| − | [[Attribute Convention for Data Discovery (ACDD) Object Conventions]]
| |
| − | | |
| − | == ISO Translation Notes ==
| |
| − | http://wiki.esipfed.org/index.php?title=Attribute_Convention_for_Data_Discovery_(ACDD)_ISO_TranslationNotes
| |
| − | | |
| − | [[Category:Attribute Conventions Dataset Discovery]]
| |
| − | [[Category: Documentation Cluster]]
| |
| − | | |
| − | | |
| − | [[Category:Attribute Conventions Dataset Discovery]]
| |
| − | [[Category: Documentation Cluster]]
| |
