open-science-catalog-validation

Validation for open-science-catalog-metadata.

Instructions

To run validation do the following:

npm install ESA-EarthCODE/open-science-catalog-validation

Then, inside a folder containing a STAC structure compatible with Open Science Catalog, run:

open-science-catalog-validation ./{eo-missions,products,projects,themes,variables,workflows,experiments}

Example for single file validation:

open-science-catalog-validation ./projects/3d-earth/collection.json

Warning

Due to the fact that on Windows file paths are case insensitive, some checks are less strict on Windows. This means in certain edge cases the validator may report validity on Windows although files are not valid. It is recommended to run the validator on Linux or MacOS systems.

How it works

This validation package is based on stac-node-validator. Additional to generic validation following the STAC spec it does some custom validation (see ./validate.js).

Open Science Catalog STAC schema

Open Science Catalog requires a certain STAC and Records structure for its entities (products, projects, variables, workflows, experiments, etc.). The schema for these can be found in ./schemas.

These schemas can also be used for e.g. automatically rendering an input form.

To access the schemas in a bundled format (only internal $refs), use the provided GH pages endpoint, e.g. https://esa-earthcode.github.io/open-science-catalog-validation/schemas/projects/children.json.

Development

For development, copy some compatible folder structure into the root folder, then run npm install followed by a npm test.