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.
Documentation: https://ismip.github.io/ISM_SimulationChecker/
conda create -n isschecker -c conda-forge isschecker
conda activate isschecker
ismip7-compliance-checker \
--source-path Models/GrIS/VUW/PISM1/CORE/C001 \
--variable-list ismip7The source path is one set counter directory: the one holding the .nc files
for a model's C001 (or E003, P012, ...) runs. The variable list says which
files to look for: ismip7_xyt for the gridded variables, ismip7_scalars
for the time series, ismip7 for both.
Findings are printed as the checker runs and written to
compliance_checker_log.txt beside the files, or under --output-path if the
files are somewhere you cannot write. 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 make the command exit non-zero, so it can be run from
a script.
| Getting started | install, lay out the files, run the checker, read the log |
| Running the checker | every option |
| What the checker checks | the six categories |
| Errors and warnings | what each severity means, and the warnings you can quiet |
| Time encoding | the timestamps and bounds each variable type needs |
| The data request | units, value ranges and experiments, variable by variable |
| Developer guide | source install, test files, tests, releases |
Problems and questions go in the issue tracker. Pull requests are welcome; the developer guide covers the source install, the tests and the release process.
Distributed under the MIT License; see LICENSE.