cf-conventions
The conventions for CF (Climate and Forecast) metadata are designed to promote the processing and sharing of files created with the NetCDF API.
https://github.com/cf-convention/cf-conventions
Category: Climate Change
Sub Category: Climate Data Standards
Keywords from Contributors
meteorology grib climate oceanography geospatial-data atmospheric-science hdf5 earth-science netcdf4 unidata
Last synced: about 19 hours ago
JSON representation
Repository metadata
AsciiDoc Source
- Host: GitHub
- URL: https://github.com/cf-convention/cf-conventions
- Owner: cf-convention
- License: cc0-1.0
- Created: 2015-06-04T10:35:10.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T14:41:48.000Z (13 days ago)
- Last Synced: 2025-04-17T23:02:48.130Z (10 days ago)
- Language: R
- Homepage: http://cfconventions.org/cf-conventions/cf-conventions
- Size: 44.9 MB
- Stars: 91
- Watchers: 70
- Forks: 49
- Open Issues: 35
- Releases: 8
-
Metadata Files:
- Readme: README.md
- Changelog: history.adoc
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Zenodo: .zenodo.json
README.md
This repository contains the official source of the CF metadata conventions.
The source files are built into HTML automatically when changes are merged into this repository.
The latest build of the specification is held in the gh-pages
branch and can be seen here.
For the official web site please visit: https://cfconventions.org and the corresponding GitHub organisation.
Contributing to the CF Conventions
The CF Conventions are changed by changing the source files in this repository.
The rules for doing this are set forth on the CF website.
Their implementation in GitHub is described in this repository's CONTRIBUTING.md file.
Building the HTML
The following steps outline how to build the CF Conventions documentation into HTML and/or PDF format using AsciiDoc:
- Ensure you have Ruby installed. (e.g.
sudo apt install ruby
) - Ensure you have a recent version of Asciidoctor installed (e.g.
gem install asciidoctor
) - Ensure you have Make installed. (e.g.
sudo apt install make
) - Clone the repository containing the AsciiDoc files. (e.g.
git clone [email protected]:cf-convention/cf-conventions.git
) - There are different options to make the conventions and conformance documents:
- (Default: Build all formats) HTML and PDF conventions and conformance documents:
make
ormake all
- HTML conventions and conformance documents:
make html
- PDF conventions and conformance documents:
make pdf
- Conventions documents (HTML and PDF):
make conventions
- Conformance documents (HTML and PDF):
make conformance
- Remove built documents and clean build directories:
make clean
- Build with the FINAL tag and a date stamp. Ensure you have manually updated the version in the
version.adoc
file before running this command:
make CF_FINAL=True
- (Default: Build all formats) HTML and PDF conventions and conformance documents:
Both HTML documents will have images embedded within .html
file.
The built documents will be rendered in the build
directory with the resulting paths:
build/cf-conventions.html
build/cf-conventions.pdf
build/conformance.html
build/conformance.pdf
Ensure the built documents meet your requirements before publishing.
See the GitHub help pages and many other git/GitHub guides for more details on how to work with repos, forks, pull requests, etc.
Latest Spec Build
Whenever a pull request is merged, a travis-ci build generates the latest specification draft and adds it to the gh-pages branch here.
The gh-pages branch is deployed to github pages at the following documents:
- https://cfconventions.org/cf-conventions/cf-conventions.html
- https://cfconventions.org/cf-conventions/cf-conventions.pdf
- https://cfconventions.org/cf-conventions/conformance.html
- https://cfconventions.org/cf-conventions/conformance.pdf
These documents are linked in the cf-conventions web site. source here which is published to: https://cfconventions.org/. The latest spec documents are linked from those web pages here: https://cfconventions.org/latest.html.
Citation (CITATION.cff)
cff-version: 1.2.0 license: - cc0-1.0 title: NetCDF Climate and Forecast (CF) Metadata Conventions version: '1.12' date-released: '2024-12-04' doi: 10.5281/zenodo.14275599 abstract: This document describes the CF conventions for climate and forecast metadata designed to promote the processing and sharing of files created with the netCDF Application Programmer Interface. The conventions define metadata that provide a definitive description of what the data in each variable represents, and of the spatial and temporal properties of the data. This enables users of data from different sources to decide which quantities are comparable, and facilitates building applications with powerful extraction, regridding, and display capabilities. The CF conventions generalize and extend the COARDS conventions. The extensions include metadata that provides a precise definition of each variable via specification of a standard name, describes the vertical locations corresponding to dimensionless vertical coordinate values, and provides the spatial coordinates of non-rectilinear gridded data. Since climate and forecast data are often not simply representative of points in space/time, other extensions provide for the description of coordinate intervals, multidimensional cells and climatological time coordinates, and indicate how a data value is representative of an interval or cell. This standard also relaxes the COARDS constraints on dimension order and specifies methods for reducing the size of datasets. authors: - affiliation: NCAR family-names: Eaton given-names: Brian - affiliation: University of Reading and UK Met Office Hadley Centre family-names: Gregory given-names: Jonathan orcid: 0000-0003-1296-8644 - affiliation: PCMDI, LLNL family-names: Drach given-names: Bob - affiliation: PCMDI, LLNL family-names: Taylor given-names: Karl orcid: 0000-0002-6491-2135 - affiliation: PMEL, NOAA family-names: Hankin given-names: Steve - affiliation: Unidata family-names: Caron given-names: John - affiliation: USGS family-names: Signell given-names: Rich - affiliation: UK Met Office family-names: Bentley given-names: Phil - affiliation: MIT family-names: Rappa given-names: Greg - affiliation: DKRZ family-names: "H\xF6ck" given-names: Heinke orcid: 0000-0002-0131-1404 - affiliation: NCAS and CEDA family-names: Pamment given-names: Alison orcid: 0000-0001-5040-4626 - affiliation: NCAS family-names: Juckes given-names: Martin - affiliation: SMHI family-names: Raspaud given-names: Martin - affiliation: Excalibur Laboratories Inc family-names: Horne given-names: Randy - affiliation: University of Reading family-names: Blower given-names: Jon - affiliation: University of Texas family-names: Whiteaker given-names: Timothy - affiliation: USGS family-names: Blodgett given-names: David - affiliation: UC Irvine family-names: Zender given-names: Charlie - affiliation: EUMETSAT family-names: Lee given-names: Daniel orcid: 0000-0002-1041-232X - affiliation: NCAS and University of Reading family-names: Hassell given-names: David orcid: 0000-0001-5106-7502 - affiliation: Corteva Agriscience family-names: Snow given-names: Alan D. - affiliation: Max Planck Institute for Meteorology family-names: "K\xF6lling" given-names: Tobias - affiliation: NOAA/CIRES/University of Colorado family-names: Allured given-names: Dave - affiliation: HDF Group family-names: Jelenak given-names: Aleksandar - affiliation: EUMETSAT family-names: Soerensen given-names: Anders Meier - affiliation: OceanDataLab family-names: Gaultier given-names: Lucile - affiliation: OceanDataLab family-names: "Herl\xE9dan" given-names: Sylvain - affiliation: Puertos del Estado, Madrid family-names: Manzano given-names: Fernando - affiliation: SMHI family-names: "B\xE4rring" given-names: Lars orcid: 0000-0001-7280-2502 - affiliation: NOAA family-names: Barker given-names: Christopher - affiliation: National Centre for Atmospheric Science and University of Reading family-names: Bartholomew given-names: Sadie L. orcid: 0000-0002-6180-3603
Owner metadata
- Name: CF Conventions
- Login: cf-convention
- Email:
- Kind: organization
- Description: Source code repository for CF Conventions documents at http://cf-convention.github.io
- Website: cf-convention.github.io
- Location: github
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/6909709?v=4
- Repositories: 8
- Last ynced at: 2023-08-18T07:27:37.480Z
- Profile URL: https://github.com/cf-convention
GitHub Events
Total
- Create event: 2
- Release event: 1
- Issues event: 35
- Watch event: 6
- Issue comment event: 363
- Push event: 66
- Pull request review comment event: 71
- Pull request event: 55
- Pull request review event: 72
- Fork event: 4
Last Year
- Create event: 2
- Release event: 1
- Issues event: 35
- Watch event: 6
- Issue comment event: 363
- Push event: 66
- Pull request review comment event: 71
- Pull request event: 55
- Pull request review event: 72
- Fork event: 4
Committers metadata
Last synced: 7 days ago
Total Commits: 1,396
Total Committers: 50
Avg Commits per committer: 27.92
Development Distribution Score (DDS): 0.739
Commits in past year: 213
Committers in past year: 15
Avg Commits per committer in past year: 14.2
Development Distribution Score (DDS) in past year: 0.648
Name | Commits | |
---|---|---|
David Hassell | d****l@n****k | 364 |
AndersMS | 6****S | 166 |
JonathanGregory | j****y@r****k | 135 |
Jeff Painter | p****1@l****v | 107 |
Daniel Lee | d****e@e****t | 96 |
Richard Hattersley | r****y@g****m | 51 |
reshel3 | r****3@l****v | 50 |
Antonio S. Cofiño | c****a@g****m | 49 |
Lars Bärring | l****g@s****e | 48 |
Charlie Zender | z****r@u****u | 46 |
David Blodgett | d****t@u****v | 38 |
Tim Whiteaker | w****r@u****u | 32 |
Gui Castelao | g****e@c****t | 29 |
Sadie L. Bartholomew | s****w@n****k | 21 |
Thomas Lavergne | t****e@m****o | 14 |
Klaus Zimmermann | k****n@s****e | 14 |
Ethan Davis | e****s@u****u | 11 |
Fernando Manzano | 5****e | 11 |
marqh | m****y@m****k | 10 |
JimBiardCics | j****d@c****g | 10 |
Daniel Neumann | d****n@d****e | 10 |
Dave Allured | d****d@n****v | 8 |
Rosalyn Hatcher | r****r@r****k | 8 |
marqh | m****h@m****t | 8 |
Tobias Kölling | t****g@m****e | 7 |
Chris Barker | C****r@n****v | 7 |
Daniel Heydebreck | h****k@d****e | 6 |
Hauke Schulz | 4****s | 4 |
Martin | m****s@s****k | 3 |
Micah Wengren | m****n@g****m | 3 |
and 20 more... |
Committer domains:
- ncas.ac.uk: 3
- usgs.gov: 3
- reading.ac.uk: 2
- llnl.gov: 2
- smhi.se: 2
- stfc.ac.uk: 2
- noaa.gov: 2
- dkrz.de: 2
- metoffice.gov.uk: 2
- met.no: 2
- eumetsat.int: 1
- uci.edu: 1
- utexas.edu: 1
- castelao.net: 1
- ucar.edu: 1
- cicsnc.org: 1
- metarelate.net: 1
- mpimet.mpg.de: 1
- squaregoldfish.co.uk: 1
- oceandatalab.com: 1
- uni-muenster.de: 1
- unican.es: 1
- ml-9578980.llnl.gov: 1
- external.eumetsat.int: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 271
Total pull requests: 341
Average time to close issues: about 1 year
Average time to close pull requests: 2 months
Total issue authors: 68
Total pull request authors: 45
Average comments per issue: 15.66
Average comments per pull request: 1.9
Merged pull request: 281
Bot issues: 0
Bot pull requests: 0
Past year issues: 35
Past year pull requests: 54
Past year average time to close issues: 2 months
Past year average time to close pull requests: 22 days
Past year issue authors: 15
Past year pull request authors: 10
Past year average comments per issue: 9.0
Past year average comments per pull request: 0.94
Past year merged pull request: 39
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- erget (31)
- JonathanGregory (22)
- davidhassell (20)
- larsbarring (17)
- rhattersley (15)
- dblodgett-usgs (11)
- martinjuckes (10)
- neumannd (10)
- cofinoa (10)
- Dave-Allured (8)
- twhiteaker (8)
- snowman2 (7)
- TomLav (6)
- ChrisBarker-NOAA (6)
- sadielbartholomew (5)
Top Pull Request Authors
- JonathanGregory (51)
- rhattersley (43)
- davidhassell (41)
- erget (23)
- reshel3 (19)
- painter1 (18)
- larsbarring (18)
- cofinoa (15)
- dblodgett-usgs (12)
- neumannd (12)
- marqh (9)
- ethanrd (9)
- Dave-Allured (7)
- RosalynHatcher (5)
- castelao (5)
Top Issue Labels
- enhancement (99)
- defect (76)
- change agreed (52)
- question (29)
- GitHub Usage (26)
- style (10)
- GitHub (7)
- standard name (6)
- no change agreed (5)
- new contributor (5)
- typo (4)
- dormant (3)
- CF1.12? (3)
- governance (3)
- agreement not to change (2)
- duplicate (2)
- frequently asked question (1)
- roadmap (1)
Top Pull Request Labels
- defect (10)
- GitHub Usage (9)
- question (4)
- enhancement (3)
- GitHub (2)
- CF1.12? (2)
Package metadata
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
proxy.golang.org: github.com/cf-convention/cf-conventions
- Homepage:
- Documentation: https://pkg.go.dev/github.com/cf-convention/cf-conventions#section-documentation
- Licenses:
- Latest release: v1.12.0 (published 5 months ago)
- Last Synced: 2025-04-26T14:04:52.374Z (2 days ago)
- Versions: 4
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%
Dependencies
- Analog-inc/asciidoctor-action v1.2 composite
- actions/checkout v2 composite
- actions/download-artifact v2 composite
- actions/upload-artifact v2 composite
Score: -Infinity