Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

CF Checker

The CF Checker is a utility that checks the contents of a NetCDF file complies with the Climate and Forecasts (CF) Metadata Convention.
https://github.com/cedadev/cf-checker

Category: Climate Change
Sub Category: Climate Data Standards

Keywords from Contributors

esgf opendap logon

Last synced: about 5 hours ago
JSON representation

Repository metadata

README.md

CF Checker

The CF Checker is a utility that checks the contents of a NetCDF file complies with the Climate and Forecasts (CF) Metadata Convention.

Dependencies

Installation

To install from PyPI:

pip install cfchecker

To install from Conda-forge:

conda create -n cfchecker -c conda-forge cfchecker # create new env OR
conda install cfchecker -c conda-forge             # install on existing env

Alternatively, to install from source:

  1. Download the cfchecker package from cfchecker releases

  2. Unpack the library:

     tar -zxf cfchecker-${version}.tar.gz

 cd cfchecker-${version}

  3. Install the package:

    • To install to a central location:

         python setup.py install

    • To install to a non standard location:

         python setup.py install --prefix=<directory>

      If directory you are installing into is not on PYTHONPATH you will need to add it.

Running the CF Checker

cfchecks [-a <area-types.xml>] [-r <regions.xml>] [-s <std_names.xml>] [-v <CFVersion>] [-x] [-t <cache_time_days>] file1 [file2...]

For further details and for other available command line options please see the help by running cfchecks -h

Environment Variables

The following parameters can be set on the command-line or through environment variables:

  1. CF_STANDARD_NAMES or (CL option -s) : The path or URL to the CF standard names table
  2. CF_AREA_TYPES or (CL option -a) : The path or URL to the CF area types table
  3. CF_REGION_NAMES or (CL option -r): The path or URL to the CF region names table

Running the Test script

In the release tarball there is a test_files directory containing a test.sh script which runs a series of test files through the CF Checker and confirms the checker is working as expected. It is a very elementary system, which will be rewritten soon. Before running it you will need to edit the location of the cfchecks script in the tests.sh file:

cfchecker="<location of cfchecks>"

Then just run the tests.sh script:

./tests.sh

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 221
Total Committers: 17
Avg Commits per committer: 13.0
Development Distribution Score (DDS): 0.498

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
RosalynHatcher r****r@r****k 111
ros r****s@4****4 42
Stephen Pascoe S****e@s****k 12
agstephens a****s@s****k 11
pascoe p****e@4****4 9
RosalynHatcher r****r@n****k 6
gmasetti g****i@c****u 6
Alan Iwi b****v@b****k 5
Alan Iwi a****i@s****k 5
Danny f****k@g****m 4
Chandin Wilson C****n@n****v 2
Jan Kretzschmar j****r@u****e 2
Antonio S. Cofiño c****a@g****m 2
Vini Salazar 1****r 1
Frederic Leclercq f****q@v****e 1
RosalynHatcher r****s@R****l 1
holtmann a****n@t****e 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 72
Total pull requests: 37
Average time to close issues: 8 months
Average time to close pull requests: 3 months
Total issue authors: 35
Total pull request authors: 13
Average comments per issue: 2.04
Average comments per pull request: 0.51
Merged pull request: 30
Bot issues: 0
Bot pull requests: 0

Past year issues: 6
Past year pull requests: 3
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 5
Past year pull request authors: 1
Past year average comments per issue: 1.5
Past year average comments per pull request: 0.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cedadev/cf-checker

Top Issue Authors

  • RosalynHatcher (24)
  • cehbrecht (4)
  • martinjuckes (3)
  • agstephens (3)
  • senesis (3)
  • tsherwen (2)
  • bertulus (2)
  • ejhyer (2)
  • giumas (2)
  • znichollscr (2)
  • chloemackallah (1)
  • apcraig (1)
  • jkretz (1)
  • ashao (1)
  • andreustaylor (1)

Top Pull Request Authors

  • RosalynHatcher (20)
  • flackdl (3)
  • znichollscr (3)
  • cofinoa (2)
  • agstephens (1)
  • valeriupredoi (1)
  • chanwilson (1)
  • giumas (1)
  • TUBklima (1)
  • jkretz (1)
  • Fred-Leclercq (1)
  • gareth-j (1)
  • vinisalazar (1)

Top Issue Labels

  • bug (22)
  • enhancement (13)
  • question (5)
  • help (2)
  • invalid (1)
  • duplicate (1)

Top Pull Request Labels

  • enhancement (2)
  • bug (1)

Package metadata

pypi.org: cfchecker

The NetCDF Climate Forecast Conventions compliance checker

  • Homepage: http://cfconventions.org/compliance-checker.html
  • Documentation: https://cfchecker.readthedocs.io/
  • Licenses: BSD License
  • Latest release: 4.1.0 (published almost 4 years ago)
  • Last Synced: 2025-04-26T14:35:40.521Z (1 day ago)
  • Versions: 17
  • Dependent Packages: 3
  • Dependent Repositories: 9
  • Downloads: 2,160 Last month
  • Rankings:
    • Dependent packages count: 2.372%
    • Average: 4.724%
    • Dependent repos count: 4.847%
    • Downloads: 6.952%
  • Maintainers (3)

Dependencies

requirements.txt pypi
  • cfunits *
  • netCDF4 *
  • numpy *
setup.py pypi
  • cfunits >=3.0.0
  • future *
  • netCDF4 *
  • numpy >=1.7

Score: 15.152726275808636