esgvoc 2.2.0

python library and CLI to interact with WCRP CVs

ESGVOC Library

ESGVOC is a Python library designed to simplify interaction with controlled vocabularies (CVs) used in WCRP climate data projects. It supports querying, caching, and validating terms across various CV repositories like the universe and project-specific repositories (e.g., CMIP6Plus, CMIP6, etc.).

Full documentation is available at https://esgf.github.io/esgf-vocab/.

---

Features

• Query controlled vocabularies:

  • Retrieve terms, collections, or descriptors.
  • Perform cross-validation and search operations.
  • Supports case-sensitive, wildcard, and approximate matching.

• Caching:

  • Download CVs to a local database for offline use.
  • Keep the local cache up-to-date.
  • Note: at present, this is a design choice. You can't use esgvoc without this cache, it always downloads the CVs to a local database first

• Validation:

  • Validate strings against CV terms and templates.

• Apps:

  • Ease some treatment using the CV.

Installation

ESGVOC is available on PyPI. Install it with pip:

pip install esgvoc

After installing ESGVOC, use this command to install the latest CVs (or update them if you have already installed ESGVOC).

esgvoc install

For developers

• with pip

pip install -e .
pip install pre-commit
pre-commit install

• with uv

uv sync
uv run pre-commit install