https://github.com/ncar/esmcol-validator

A utility for validating esm-collection json files against the esm-collection-spec: https://github.com/NCAR/esm-collection-spec
https://github.com/ncar/esmcol-validator

data-catalog intake-esm xdev

Last synced: 11 months ago
JSON representation

A utility for validating esm-collection json files against the esm-collection-spec: https://github.com/NCAR/esm-collection-spec

• Host: GitHub
• URL: https://github.com/ncar/esmcol-validator
• Owner: NCAR
• License: apache-2.0
• Created: 2020-01-17T19:21:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-02-01T18:13:33.000Z (about 6 years ago)
• Last Synced: 2025-02-12T05:06:19.785Z (12 months ago)
• Topics: data-catalog, intake-esm, xdev
• Language: Python
• Homepage:
• Size: 39.1 KB
• Stars: 0
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/NCAR/esmcol-validator/CI?logo=Github&style=for-the-badge)](https://github.com/NCAR/esmcol-validator/actions)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/NCAR/esmcol-validator/code-style?label=Code%20Style&logo=GitHub&style=for-the-badge)](https://github.com/NCAR/esmcol-validator/actions)

[![PyPI](https://img.shields.io/pypi/v/esmcol-validator?logo=PyPI&style=for-the-badge)](https://pypi.org/project/esmcol-validator)

[![Conda](https://img.shields.io/conda/v/conda-forge/esmcol-validator?label=conda-forge&style=for-the-badge)](https://anaconda.org/conda-forge/esmcol-validator)

[![](https://img.shields.io/codecov/c/github/NCAR/esmcol-validator.svg?style=for-the-badge)](https://codecov.io/gh/NCAR/esmcol-validator)

# Earth System Model (ESM)Collection specification Validator

- [Earth System Model (ESM)Collection specification Validator](#earth-system-model-esmcollection-specification-validator)

  - [Installation](#installation)

  - [Usage](#usage)

This utility allows users to validate esm-collection json files against the [esm-collection-spec](https://github.com/NCAR/esm-collection-spec).

## Installation

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

Using Pip via PyPI:

```bash

python -m pip install esmcol-validator

```

Using Conda:

```bash

conda install -c conda-forge esmcol-validator

```

Or from the source repository:

```bash

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

```

## Usage

```bash

$ 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:

```bash

$ 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

}

```