Deprecated 2016. Visit the [1.2 Metadata Profile](./ioos-metadata-profile-v1-2.html) page for the current version.Edit me
This page provides description of the deprecated IOOS NetCDF Metadata Profile.
- NOAA NODC NetCDF Templates v1.1 is required; the NOAA NCEI NetCDF Templates v2.0 is not recommended at the moment.
- Attribute Conventions for Dataset Discovery (ACDD) v1.1 is required. The ACDD v1.3 is not recommended at the moment, except for the
- Each attribute in the Profile is either required or recommended.
- All required attributes must have meaningful values assigned to them in accordance with the rules prescribed by the corresponding Convention or Template.
- Each and all of the recommended attributes may be omitted; however, it is highly desirable that these attributes are included into the NetcDF metadata AND have meaningful values assigned to them.
platform_variable:short_nameare the only interchangeable attributes - either a single
platform_variable:ioos_codeor a combination of
naming_authorityis required to ensure that ncSOS will be able to produce the IOOS SOS Asset Identifier for the specific platform (see the NetCDF to IOOS SOS Crosswalk for details). The rest of attributes may not be substituted for one another.
platform_vocabularyattribute is at the moment the only pure ACDD v1.3 attribute that is included in the Profile.
- This document only describes a fraction of the Profile:
- attributes that are IOOS-specific;
- attributes with a different role in the Templates; for example, the attribute
_FillValueis required by the NODC Template; however, the Profile just recommends to use it because it is optional in the IOOS SOS metadata set (whether the Template requirement should prevail, is beyond the scope of the Profile description);
- attributes that are required by the Profile regardless of their role in the Templates.
- Other Profile attributes are described in the NOAA NODC NetCDF Templates v1.1. A set of “Gold Standard” example NetCDF files, which precisely follow the NODC/NCEI Templates, may be found here or here.
- The U.S. IOOS National Glider Data Assembly Center currently uses a slightly different NetCDF Metadata Profile; work is in progress to harmonize the NGDAC and IOOS NetCDF Profiles.
IOOS NetCDF Metadata Profile Attributes
|contributor_name||ACDD||The name of any individuals or institutions that contributed to the creation of this data. Combined with the
|contributor_role||ACDD||The role of any individuals or institutions that contributed to the creation of this data.
For the IOOS ncSOS,
|creator_address||IOOS||Street address of the person or organization that collected the data.||global||recommended|
|creator_city||IOOS||City of the person or organization that collected the data.||global||recommended|
|creator_country||IOOS||Country of the person or organization that operates a platform or network, which collected the observation data.||global||required|
|creator_email||ACDD||Email address of the person or institution that collected the data.||global||required|
|creator_name||ACDD||Name of the person or organization that collected the data.||global||recommended|
|creator_phone||IOOS||The phone number of the person or group that collected the data.||global||recommended|
|creator_sector||IOOS||IOOS classifier that best describes the platform (network) operator’s societal sector.
|creator_state||IOOS||State of the person or organization that collected the data.||global||recommended|
|creator_url||ACDD||The URL of the institution that collected the data.||global||recommended|
|creator_zipcode||IOOS||ZIP code of the person or organization that collected the data.||global||recommended|
|featureType||CF||CF attribute for identifying the featureType, e.g. featureType = “timeSeries”.||global||required|
|CF||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:
|geophysical_variable:standard_name||CF||Standardized field which uses the CF Standard Names. If a variables does not have an existing standard_name in the CF-managed list, this attribute should not be used. In these cases, a standard name can be proposed to the CF community for consideration and acceptance.||variable||required|
|id||ACDD||An identifier for the data set, provided by and unique within its naming authority. The combination of the
|institution||ACDD||The institution of the person or group that collected the data.||global||required|
|instrument_variable:discriminant||IOOS||The value of a
|variable||required, if applicable|
|keywords||ACDD||A comma separated list of key words and phrases.||global||recommended|
|license||ACDD||Describe the restrictions to data access and distribution.||global||recommended|
|naming_authority||ACDD||The organization that provides the
The naming authority should be uniquely specified by this attribute; the combination of the
|Name of the platform(s) that supported the sensor data used to create this data set or product. Platforms can be of any type, including satellite, ship, station, aircraft or other. The controlled vocabulary must be indicate in
The value of the attribute should be set to another variable which contains the details of the platform. There can be multiple platforms involved depending on if all the instances of the featureType in the collection share the same platform or not. If multiple platforms are involved, a variable should be defined for each platform and referenced from the geophysical variable in a space separated string.
|platform_variable:ioos_code||IOOS||Provides IOOS asset identification similar to
NOTE: interchangeable with
|platform_variable:long_name||NODC Templates||Provide a descriptive, long name for this variable.||variable||required|
|platform_variable:short_name||IOOS||Provide a short name for the platform. Similar to ID, a
NOTE: interchangeable with
|platform_variable:type||IOOS||In conjunction with a
(NCEI Templates v2.0)
|Controlled vocabulary for the names used in the “platform” attribute.
It is recommended that this attribute is used in conjunction with the
As an alternative (although not recommended), a NetCDF file may follow the NCEI Template v2.0, which suggests the use of “NASA GCMD Platform Keywords Version 8.1” string as the fixed value for the
|publisher_address||IOOS||Street address of the person or organization that distributes the data.||global||recommended|
|publisher_city||IOOS||City of the person or organization that distributes the data.||global||recommended|
|publisher_country||IOOS||Country of the person or organization that distributes the data.||global||required|
|publisher_email||ACDD||The email address of the person or group that distributes the data files.||global||required|
|publisher_name||ACDD||Name of the person or group that distributes the data files. Use the conventions described above when identifying persons and/or institutions when applicable.||global||required|
|publisher_phone||IOOS||The phone number of the person or group that distributes the data files.||global||recommended|
|publisher_state||IOOS||State of the person or organization that distributes the data.||global||recommended|
|publisher_url||ACDD||URL of the person or group that distributes the data files.||global||recommended|
|publisher_zipcode||IOOS||ZIP code of the person or organization that distributes the data.||global||recommended|
|standard_name_vocabulary||ACDD||Standardized field which uses the CF Standard Names. If a variables does not have an existing standard_name in the CF-managed list, this attribute should not be used. In these cases, a standard name can be proposed to the CF community for consideration and acceptance.||global||required|
|summary||ACDD||One paragraph describing the data set.||global||recommended|
|title||ACDD||One sentence about the data contained within the file.||global||required|
|units||CF||Required for most all variables that represent dimensional quantities. The value should come from