Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

The NetCDF Climate Forcast Conventions compliance checker

Project description

# 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.

## Prerequisites

## Installation

To install from [PyPI](

pip install cfchecker

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 install

    • To install to a non standard location:

      python 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 area_types.xml] [-s|–cf_standard_names standard_names.xml] [-v|–version CFVersion] file1 [file2…]

### 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 tables

### Wrapper script

A wrapper to cfchecks, called cf-checker, is provided in the src/ directory, which will maintain local copies of the standard names table and the area types table, and will refresh these local copies only if the age of the file (based on its modification time) is more than a specified maximum, defaulting to 1 day. This allows for running the checker repeatedly without refetching the tables on each invocation, while still keeping them reasonably up to date.

For a usage message, type cf-checker -h

Note that the wrapper defaults to storing the downloaded files in /var/spool/cf-checker, so if the script is used unmodified then this directory should be created or else an alternative value should be passed as a command line option (-d). Ensure either that all users have write permission to the directory used, or else that a user that does have write permission runs a cron job to refresh the tables. For the latter purpose, it is permissible to run the wrapper without specifying any data files to check, in which it will do no more than update the tables; this is still conditional on age, so for this purpose it is recommended to run the wrapper with a maximum age of zero (-t 0), and to run the cron job at intervals not exceeding the default maximum age.

The wrapper is maintained by CEDA and not by NCAS CMS.

### Running the Test script

In the release tarball there is a test_files directory containing a 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 cfchecker script in the file:

cfchecker=”<location of cfchecks>”

Then just run the script:


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cfchecker-3.0.5.tar.gz (26.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page