{"id":13948873,"url":"https://github.com/cedadev/cf-checker","last_synced_at":"2025-04-07T14:13:13.054Z","repository":{"id":18314779,"uuid":"21493628","full_name":"cedadev/cf-checker","owner":"cedadev","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-02T09:53:38.000Z","size":17836,"stargazers_count":73,"open_issues_count":21,"forks_count":31,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-10-29T19:49:13.239Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cedadev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-07-04T10:19:48.000Z","updated_at":"2024-10-29T01:26:27.000Z","dependencies_parsed_at":"2024-11-06T01:03:12.504Z","dependency_job_id":"c08b0456-05d8-4536-b3a2-42ffd1062aff","html_url":"https://github.com/cedadev/cf-checker","commit_stats":{"total_commits":221,"total_committers":17,"mean_commits":13.0,"dds":0.497737556561086,"last_synced_commit":"c0486c606f7cf4d38d3b484b427726ce1bde73ee"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcf-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcf-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcf-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcf-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cedadev","download_url":"https://codeload.github.com/cedadev/cf-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284940,"owners_count":20913704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-08T05:01:33.077Z","updated_at":"2025-04-07T14:13:13.032Z","avatar_url":"https://github.com/cedadev.png","language":"Python","funding_links":[],"categories":["Climate Change"],"sub_categories":["Climate Data Standards"],"readme":"# CF Checker\n\nThe CF Checker is a utility that checks the contents of a NetCDF file complies with the Climate and Forecasts (CF) Metadata Convention.\n\n## Dependencies\n\n* The package runs on [**Linux**](http://en.wikipedia.org/wiki/Linux)\n  and [**Mac OS**](http://en.wikipedia.org/wiki/Mac_OS) operating systems.\n\n* [Python 3.x](https://www.python.org/)\n\n* [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.\n\n* [cfunits-python](https://bitbucket.org/cfpython/cfunits-python) package version 3.0.0 or newer\n\n* [numpy](https://pypi.python.org/pypi/numpy) version 1.15 or newer\n\n## Installation\n\nTo install from [PyPI](https://pypi.python.org/pypi/cfchecker):\n\n    pip install cfchecker\n\nTo install from [Conda-forge](https://github.com/conda-forge/cfchecker-feedstock):\n\n    conda create -n cfchecker -c conda-forge cfchecker # create new env OR\n    conda install cfchecker -c conda-forge             # install on existing env\n\nAlternatively, to install from source:\n\n1. Download the cfchecker package from [cfchecker releases](https://github.com/cedadev/cf-checker/releases)\n\n2. Unpack the library:\n\n        tar -zxf cfchecker-${version}.tar.gz\n\n        cd cfchecker-${version}\n\n3. Install the package:\n\n   * To install to a central location:\n\n            python setup.py install\n\n   * To install to a non standard location:\n\n            python setup.py install --prefix=\u003cdirectory\u003e\n\n     If directory you are installing into is not on PYTHONPATH you will need to add it.\n     \n## Running the CF Checker\n\n`cfchecks [-a \u003carea-types.xml\u003e] [-r \u003cregions.xml\u003e] [-s \u003cstd_names.xml\u003e] [-v \u003cCFVersion\u003e] [-x] [-t \u003ccache_time_days\u003e] file1 [file2...]`\n\nFor further details and for other available command line options please see the help by running `cfchecks -h`\n\n### Environment Variables\n\nThe following parameters can be set on the command-line or through environment variables:\n\n1. `CF_STANDARD_NAMES` or (CL option `-s`) : The path or URL to the CF standard names table\n2. `CF_AREA_TYPES` or (CL option `-a`) : The path or URL to the CF area types table\n3. `CF_REGION_NAMES` or (CL option `-r`): The path or URL to the CF region names table\n\n\n### Running the Test script\n\nIn 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:\n\n    cfchecker=\"\u003clocation of cfchecks\u003e\"\n\nThen just run the `tests.sh` script:\n\n    ./tests.sh\n    \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedadev%2Fcf-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcedadev%2Fcf-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedadev%2Fcf-checker/lists"}