Developer guide

Guidance for contributing to the checker and for maintaining its releases. If you only want to check a submission, you do not need any of this — install from conda-forge as described in Getting started.

The repository is laid out like this:

isschecker/checker.py

the checker itself, and the ismip7-compliance-checker entry point.

isschecker/generate.py

the synthetic file generator, and the ismip7-generate-test-files entry point.

isschecker/data/

the data request CSVs and the grid definition files (gdfs/), bundled with the package as package data.

tests/

the regression suite, including the reference log that pins the checker’s output.

docs/

these pages.

Contents

• Installing from source
  • Dependencies
• Generating test files
  • Usage
  • Key options
  • Examples
  • Implemented conventions
  • Notes
• Running the tests
  • The reference log
  • What CI runs
• Building the documentation
  • Build them locally
  • Layout
  • The generated tables
  • How it is published
• Releasing
  • Cutting a release
  • Confirming what was published
  • Maintaining the feedstock