cf-conventions

AsciiDoc Source

https://github.com/cf-convention/cf-conventions

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    20 of 50 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords from Contributors

atmospheric-science ocean scheduler
Last synced: 6 months ago · JSON representation ·

Repository

AsciiDoc Source

Basic Info
Statistics
  • Stars: 91
  • Watchers: 70
  • Forks: 49
  • Open Issues: 37
  • Releases: 8
Created almost 11 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Zenodo

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:

  1. Ensure you have Ruby installed. (e.g. sudo apt install ruby)
  2. Ensure you have a recent version of Asciidoctor installed (e.g. gem install asciidoctor)
  3. Ensure you have Make installed. (e.g. sudo apt install make)
  4. Clone the repository containing the AsciiDoc files. (e.g. git clone git@github.com:cf-convention/cf-conventions.git)
  5. There are different options to make the conventions and conformance documents:
    • (Default: Build all formats) HTML and PDF conventions and conformance documents: make or make 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

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.

Owner

  • Name: CF Conventions
  • Login: cf-convention
  • Kind: organization
  • Location: github

Source code repository for CF Conventions documents at http://cf-convention.github.io

Citation (CITATION.cff)

cff-version: 1.2.0
license:
- CC0-1.0
title: NetCDF Climate and Forecast (CF) Metadata Conventions
version: '1.12'
message: "Please use the following metadata to cite the latest release of the CF conventions:"
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

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 38
  • Watch event: 6
  • Issue comment event: 467
  • Push event: 79
  • Pull request review comment event: 72
  • Pull request event: 56
  • Pull request review event: 73
  • Fork event: 5
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 38
  • Watch event: 6
  • Issue comment event: 467
  • Push event: 79
  • Pull request review comment event: 72
  • Pull request event: 56
  • Pull request review event: 73
  • Fork event: 5

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 1,407
  • Total Committers: 50
  • Avg Commits per committer: 28.14
  • Development Distribution Score (DDS): 0.741
Past Year
  • Commits: 208
  • Committers: 14
  • Avg Commits per committer: 14.857
  • Development Distribution Score (DDS): 0.606
Top Committers
Name Email Commits
David Hassell d****l@n****k 364
AndersMS 6****S 166
JonathanGregory j****y@r****k 146
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...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 267
  • Total pull requests: 338
  • 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: 16.13
  • Average comments per pull request: 1.92
  • Merged pull requests: 282
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 25
  • Pull requests: 47
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 24 days
  • Issue authors: 13
  • Pull request authors: 9
  • Average comments per issue: 8.04
  • Average comments per pull request: 1.06
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • erget (31)
  • JonathanGregory (22)
  • davidhassell (18)
  • rhattersley (15)
  • larsbarring (15)
  • dblodgett-usgs (11)
  • martinjuckes (10)
  • neumannd (10)
  • cofinoa (10)
  • twhiteaker (8)
  • snowman2 (7)
  • Dave-Allured (6)
  • ChrisBarker-NOAA (6)
  • painter1 (5)
  • TomLav (5)
Pull Request Authors
  • JonathanGregory (64)
  • davidhassell (44)
  • rhattersley (43)
  • erget (24)
  • cofinoa (23)
  • larsbarring (22)
  • reshel3 (19)
  • painter1 (18)
  • dblodgett-usgs (12)
  • neumannd (11)
  • marqh (9)
  • TomLav (8)
  • ethanrd (8)
  • Dave-Allured (7)
  • ChrisBarker-NOAA (7)
Top Labels
Issue Labels
enhancement (93) defect (72) change agreed (35) question (28) GitHub Usage (24) style (10) GitHub (7) standard name (6) CF1.12? (6) no change agreed (5) typo (4) new contributor (4) governance (3) dormant (3) agreement not to change (1) roadmap (1) frequently asked question (1) duplicate (1)
Pull Request Labels
defect (12) GitHub Usage (11) enhancement (5) question (4) GitHub (4) CF1.12? (4) change agreed (1)

Packages

  • 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
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago

Dependencies

.github/workflows/adoc_build.yml actions
  • Analog-inc/asciidoctor-action v1.2 composite
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/upload-artifact v2 composite