ISMIP7 Compliance Checker¶
isschecker checks ISMIP7 NetCDF simulation datasets against the ISMIP7 data
request conventions, 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/ISMIP7/SYNTH1/CORE/C001 \
--variable-list ismip7
Install the checker, run it over a submission, and read what it tells you.
What each check looks at, how errors and warnings differ, how time is encoded, and the data request the checks come from.
Work on the checker: install from source, generate test files, run the test suite, build these docs, and cut a release.
What is checked¶
Every file is checked in five categories — naming, numerical values, spatial grid, time axis, and attributes — described in What the checker checks. The criteria themselves come from the data request files bundled with the package and are listed in The data request.
Findings come at two severities. 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, so a run can be wired into a script without warnings failing it. See Errors and warnings.
Where things live¶
The checker is developed at ismip/ISM_SimulationChecker and released through conda-forge. Problems and questions belong in the issue tracker.