WCRP Compliance Checker Plugins

This IOOS/compliance-checker plugins checks compliance with WCRP Projects specifications:

Installation

Pip

To install IOOS compliance-checker and the wcrp plugins :

pip install cc-plugin-wcrp

See the IOOS/compliance-checker for additional Installation notes.

If you have an old version of esgvoc, you should upgrade it:

pip install esgvoc --upgrade

[!CAUTION]

The CMIP7 and CORDEX-CMIP6 coordinate checks require esgvoc>=7.0.0, including the coordinate descriptor models and compatible configured project/universe databases. If the installed version is too old or the required records cannot be read, the plugin emits one high-severity COORD000 result with the technical reason and skips the dependent coordinate checks. Horizontal topology is configured project-wide in each project configuration under config/wcrp/mappings/grid_topology.toml.

Then, use the commands below to activate the project you want:

esgvoc use project@latest universe@latest

for example for CMIP6 :

esgvoc use cmip6@latest universe@latest

The projects currently available in both 'cc_plugin_wcrp' and 'esgvoc' are:

cmip6, cmip6plus, cmip7, and cordex-cmip6.

Usage

compliance-checker -l

This command displays the checkers already present on the iOS compliance checker in addition to the recently installed WCRP plugins :

 - wcrp_cmip6 (x.x.x)
 - wcrp_cordex_cmip6 (x.x.x)

To run the plugins on IOOS CC, use the following command:

compliance-checker -t ''plugin'' path/to/data/file.nc

Example for WCRP CMIP6 plugin :

compliance-checker -t wcrp_cmip6:1.0  path/to/data/CMIP6/CMIP/IPSL/IPSL-CM5A2-INCA/historical/r1i1p1f1/Amon/pr/gr/v20240619/pr_Amon_IPSL-CM5A2-INCA_historical_r1i1p1f1_gr_185001-201412.nc

CORDEX-CMIP6 also relies on verification via ESGVoc by default. To run its variable and coordinate metadata checks against legacy CMOR tables instead, select the optional path:

compliance-checker -t wcrp_cordex_cmip6 \
  -O wcrp_cordex_cmip6:verification_against_tables \
  -O wcrp_cordex_cmip6:tables_dir=path/to/cordex-cmip6-cmor-tables \
  path/to/data/file.nc

The CMOR-table base URL is configurable under [cmor_tables] in plugins/cordex_cmip6/config/wcrp/cordex.toml. If no custom table path is provided, the tables will be automatically downloaded and cached. A re-download of the cached tables can be triggered with -O wcrp_cordex_cmip6:force_table_download.

By default, the output is in plain text, but you can specify other formats with the -f option :

compliance-checker -t ''plugin'' path/to/data/file.nc -f json
compliance-checker -t ''plugin'' path/to/data/file.nc -f html