ISMIP7 Compliance Checker

Checks ISMIP7 NetCDF model output against the ISMIP7 data request, so that a submission can be corrected before it is archived rather than after. Point it at a directory of files and it writes a log saying, file by file, what is wrong and how serious it is.

conda create -n isschecker -c conda-forge isschecker
conda activate isschecker
ismip7-compliance-checker \
    --source-path Models/GrIS/VUW/PISM1/CORE/C001 \
    --variable-list ismip7
Getting started

Install the checker, lay out your files, run it, and read the log.

Getting started
User guide

Every option, what each check looks at, how errors and warnings differ, how time is encoded, and the data request the checks come from.

User guide
Developer guide

Work on the checker: install from source, generate test files, run the tests, build these docs, and cut a release.

Developer guide

What is checked

Every file is checked in six categories: naming, numerical values, spatial grid, time axis, consistency between files, and attributes. What the checker checks describes them. The criteria come from the data request files bundled with the package and are listed in The data request.

An error means the file cannot be used as submitted. A warning means it is usable but departs from what was asked for. Only errors change the exit status; see Errors and warnings.

Where things live

The checker is developed at ismip/ISM_SimulationChecker and released through conda-forge. Problems and questions go in the issue tracker.