Data

Tools

Indexes

Applications

Experiments

Open Source Science

cf-checker

https://github.com/cedadev/cf-checker

Science Score: 23.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    10 of 17 committers (58.8%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: cedadev
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 17 MB
Statistics
  • Stars: 80
  • Watchers: 22
  • Forks: 35
  • Open Issues: 30
  • Releases: 13
Created over 11 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

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

  • Name: Centre for Environmental Data Analysis Developers
  • Login: cedadev
  • Kind: organization
  • Location: UK

GitHub Events

Total
  • Commit comment event: 2
  • Issues event: 5
  • Watch event: 10
  • Issue comment event: 9
  • Pull request event: 1
  • Fork event: 3
Last Year
  • Commit comment event: 2
  • Issues event: 5
  • Watch event: 10
  • Issue comment event: 9
  • Pull request event: 1
  • Fork event: 3

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 221
  • Total Committers: 17
  • Avg Commits per committer: 13.0
  • Development Distribution Score (DDS): 0.498
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
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 (Top 20 + Academic)
stfc.ac.uk: 3 tu-berlin.de: 1 vliz.be: 1 uni-leipzig.de: 1 noaa.gov: 1 builder.jc.rl.ac.uk: 1 ccom.unh.edu: 1 ncas.ac.uk: 1 reading.ac.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 75
  • Total pull requests: 39
  • Average time to close issues: 8 months
  • Average time to close pull requests: 5 months
  • Total issue authors: 38
  • Total pull request authors: 14
  • Average comments per issue: 1.95
  • Average comments per pull request: 0.51
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 8
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 7
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • RosalynHatcher (24)
  • cehbrecht (4)
  • martinjuckes (3)
  • agstephens (3)
  • senesis (3)
  • FObersteiner (2)
  • tsherwen (2)
  • bertulus (2)
  • ejhyer (2)
  • giumas (2)
  • mankoff (1)
  • bascrezee (1)
  • alaniwi (1)
  • BorjaEst (1)
  • vinisalazar (1)
Pull Request Authors
  • RosalynHatcher (20)
  • flackdl (3)
  • sfinkens (2)
  • cofinoa (2)
  • znichollscr (2)
  • gareth-j (2)
  • agstephens (1)
  • valeriupredoi (1)
  • chanwilson (1)
  • giumas (1)
  • TUBklima (1)
  • jkretz (1)
  • Fred-Leclercq (1)
  • vinisalazar (1)
Top Labels
Issue Labels
bug (22) enhancement (13) question (5) help (2) invalid (1) duplicate (1)
Pull Request Labels
enhancement (2) bug (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
proxy.golang.org: github.com/cedadev/cf-checker
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

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