Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cedadev/cf-checker
https://github.com/cedadev/cf-checker
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cedadev/cf-checker
- Owner: cedadev
- License: other
- Created: 2014-07-04T10:19:48.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-10-17T13:18:13.000Z (about 2 years ago)
- Last Synced: 2024-05-19T14:44:47.184Z (6 months ago)
- Language: Python
- Size: 17 MB
- Stars: 69
- Watchers: 24
- Forks: 31
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - 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. (Climate Change / Climate Data Standards)
README
# 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
* The package runs on [**Linux**](http://en.wikipedia.org/wiki/Linux)
and [**Mac OS**](http://en.wikipedia.org/wiki/Mac_OS) operating systems.* [Python 3.x](https://www.python.org/)
* [netcdf4-python](https://pypi.python.org/pypi/netCDF4) at version 1.2.5 or newer. This package requires [netCDF](https://www.unidata.ucar.edu/software/netcdf/), [HDF5](https://www.hdfgroup.org/solutions/hdf5/) and [zlib](ftp://ftp.unidata.ucar.edu/pub/netcdf/netcdf-4) libraries.
* [cfunits-python](https://bitbucket.org/cfpython/cfunits-python) package version 3.0.0 or newer
* [numpy](https://pypi.python.org/pypi/numpy) version 1.15 or newer
## Installation
To install from [PyPI](https://pypi.python.org/pypi/cfchecker):
pip install cfchecker
To install from [Conda-forge](https://github.com/conda-forge/cfchecker-feedstock):
conda create -n cfchecker -c conda-forge cfchecker # create new env OR
conda install cfchecker -c conda-forge # install on existing envAlternatively, to install from source:
1. Download the cfchecker package from [cfchecker releases](https://github.com/cedadev/cf-checker/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=
If directory you are installing into is not on PYTHONPATH you will need to add it.
## Running the CF Checker`cfchecks [-a ] [-r ] [-s ] [-v ] [-x] [-t ] 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=""
Then just run the `tests.sh` script:
./tests.sh