Earth System Model (ESM)Collection specification Validator

• Earth System Model (ESM)Collection specification Validator
  • Installation
  • Usage

This utility allows users to validate esm-collection json files against the esm-collection-spec.

Installation

The validator can be installed in any of the following ways:

Using Pip via PyPI:

python -m pip install esmcol-validator

Using Conda:

conda install -c conda-forge esmcol-validator

Or from the source repository:

python -m pip install git+https://github.com/NCAR/esmcol-validator.git

Usage

$ esmcol-validator --help
Usage: esmcol-validator [OPTIONS] ESMCOL_FILE
  A utility that allows users to validate esm-collection json files against
  the esm-collection-spec.
Options:
  --esmcol-spec-dirs TEXT
  --version TEXT           [default: master]
  --verbose                [default: False]
  --timer                  [default: False]
  --log-level TEXT         [default: CRITICAL]
  --help                   Show this message and exit.

Example:

$ esmcol-validator sample-pangeo-cmip6-collection.json
{'collections': {'valid': 1, 'invalid': 0}, 'catalogs': {'valid': 1, 'invalid': 0}, 'unknown': 0}
{
    "collections": {
        "valid": 1,
        "invalid": 0
    },
    "catalogs": {
        "valid": 1,
        "invalid": 0
    },
    "unknown": 0
}