https://github.com/stac-extensions/cf
Allows to provide the Standard Name Table based on the CF metadata convention.
https://github.com/stac-extensions/cf
cf
Last synced: 5 months ago
JSON representation
Allows to provide the Standard Name Table based on the CF metadata convention.
- Host: GitHub
- URL: https://github.com/stac-extensions/cf
- Owner: stac-extensions
- License: apache-2.0
- Created: 2023-01-25T09:42:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-30T09:18:32.000Z (almost 3 years ago)
- Last Synced: 2023-08-30T13:38:41.456Z (almost 3 years ago)
- Topics: cf
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CF Extension Specification
- **Title:** CF
- **Identifier:**
- **Field Name Prefix:** cf
- **Scope:** Item, Collection
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
- **Owner**: @Fred-Leclercq
This document explains the CF Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
It adds a field to provide the Standard Name Table based on the [CF metadata convention](http://cfconventions.org/).
- Examples:
- [Item](examples/item.json) and [Collection](examples/collection.json):
Shows the basic usage of the extension in a STAC Item and a corresponding summarizing STAC Collection
- [Standalone Collection](examples/standalone_collection.json):
Shows the basic usage of the extension in a STAC Collection without items
- [JSON Schema](json-schema/schema.json)
- [Changelog](./CHANGELOG.md)
## Fields
The fields in the table below can be used in these parts of STAC documents:
- [ ] Catalogs
- [x] Collections
- [x] Item Properties (incl. Summaries in Collections)
- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- [ ] Links
| Field Name | Type | Description |
| ------------ | --------------------------- | ------------------------------------ |
| cf:parameter | \[[CF Object](#CF-object)\] | **REQUIRED**. CF Standard Name Table |
### Additional Field Information
#### cf:parameter
The `cf:parameter` array is used to describe the parameters in an Asset or Collection.
It requires at least one entry with a non-empty name.
This enables clients to read the file and understand which parameters are available.
If assets with a `cf:parameter` array are provided, the field may optionally be used in the
Item Properties or Collection and it must summarize the available parameters in the assets.
This must be the 'union' of all the possible parameters represented in assets.
If no assets are provided in a Collection, the field can be used freely to describe the Collection for e.g. search.
An Item is only allowed to use `cf:parameter` in its Properties if it has at least one asset with a defined parameter array.
The `cf:parameter` list in Item Properties or Collections should be considered merely informative -
clients should rely on the `cf:parameter` of each asset, if available.
#### CF Object
This object should contain a variable name from the [CF list](https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html)
and where applicable a unit from the [UDUNITS-2 database](https://docs.unidata.ucar.edu/udunits/current/)
| Field Name | Type | Description |
| ---------- | ------ | ----------- |
| name | string | **REQUIRED**. Should be a non-empty value from the CF standard names list |
| unit | string | Indicates the unit, preferably available in the database from the UDUNITS-2 package (unidata) |
## Contributing
All contributions are subject to the
[STAC Specification Code of Conduct](https://github.com/radiantearth/stac-spec/blob/master/CODE_OF_CONDUCT.md).
For contributions, please follow the
[STAC specification contributing guide](https://github.com/radiantearth/stac-spec/blob/master/CONTRIBUTING.md) Instructions
for running tests are copied here for convenience.
### Running tests
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
your command line run:
```bash
npm install
```
Then to check markdown formatting and test the examples against the JSON schema, you can run:
```bash
npm test
```
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
If the tests reveal formatting problems with the examples, you can fix them with:
```bash
npm run format-examples
```