Skip to main content

A package to validate ESM Collection files

Project description

GitHub Workflow Status GitHub Workflow Status PyPI

Earth System Model (ESM)Collection specification Validator

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
}

Project details


Download files

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

Source Distribution

esmcol-validator-2020.1.29.tar.gz (17.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page