Skip to content

Overview & Installation

🌍 Scientific Context

The WCRP projects (such as CMIP6, CORDEX, CORDEX-CMIP6) produce large volumes of NetCDF files.
The cc-plugin-wcrp provides plugins that call automated quality and consistency checks to verify compliance with WCRP Projects standards , including DRS structure, controlled vocabulary (CV), attributes, and temporal continuity.

⚙️ Architecture Overview

Layer Component Description
Base Framework IOOS Compliance Checker Provides the core plugin mechanism and test runner
Plugin Package cc-plugin-wcrp Adds project-specific checks for CMIP6, CORDEX, and CORDEX-CMIP6
Controlled Vocabulary esgvoc Supplies the CV (activity_id, source_id, etc.)
Configuration wcrp_config.toml Defines active checks, thresholds, and DRS rules

🧩 Requirements

Python ≥ 3.10
Dependencies (installed automatically):

  • netCDF4
  • cfchecker
  • compliance-checker>=5.1.2
  • esgvoc
  • cftime
  • pooch

🛠️ Installation

Pip Installation

pip install cc-plugin-wcrp

Conda-forge Installation

To install from conda-forge in a new conda environment (for example, cc-wcrp):

conda create -n cc-wcrp -c conda-forge cc-plugin-wcrp
conda activate cc-wcrp

Pip Installation from source

Clone the repository and cd into the repository folder, then:

pip install -e .

Esgvoc Installation

If you have an old version of esgvoc, you should upgrade it using the same package manager.

With pip:

pip install esgvoc --upgrade

With conda:

conda update -c conda-forge esgvoc

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

Advanced: Installing pre-release versions

Beta and release candidate versions are available for testing upcoming changes before a stable release.

Using pip (PyPI)

To install a specific pre-release (for example, 2.4.0b3):

pip install "cc-plugin-wcrp==2.4.0b3"

Using conda (conda-forge)

Pre-release versions are available under the dedicated cc-plugin-wcrp_rc label.

To install a specific pre-release in a new conda environment:

conda create -n cc-wcrp-beta \
  -c conda-forge/label/cc-plugin-wcrp_rc \
  -c conda-forge \
  "cc-plugin-wcrp=2.4.0b3"

conda activate cc-wcrp-beta

Available pre-release packages can be found on Anaconda.org.

Pre-release versions are intended for testing. Make sure to use compatible ESGVOC project specifications, as described above.

Usage

Verify the installation:

For cc-plugin-wcrp :

compliance-checker -l

Normally, you should have a list of all available plugins with the compliance checker, in addition to the wcrp_cmip6 and wcrp_cordex_cmip6 plugins

IOOS compliance checker available checker suites:
 - acdd:1.1
 - acdd:1.3
 - cc6:0.4.0
 - cf:1.10
 - cf:1.11
 - cf:1.6
 - cf:1.7
 - cf:1.8
 - cf:1.9
 - ioos:0.1
 - ioos:1.1
 - ioos:1.2
 - ioos_sos:0.1
 - mip:0.4.0
 - wcrp_cmip6:1.0
 - wcrp_cordex_cmip6:1.0

For esgvoc :

esgvoc --help
# or
pip show esgvoc