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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

esgvoc-5.0.1.tar.gz (5.7 MB view details)

Uploaded Jul 30, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

esgvoc-5.0.1-py3-none-any.whl (236.6 kB view details)

Uploaded Jul 30, 2026 Python 3

File details

Details for the file esgvoc-5.0.1.tar.gz.

File metadata

Download URL: esgvoc-5.0.1.tar.gz
Upload date: Jul 30, 2026
Size: 5.7 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for esgvoc-5.0.1.tar.gz
Algorithm	Hash digest
SHA256	`97d90ba8b38a35b13f16c08b166b0e2921b50c4d4cd20dd277cd505c3029fb94`
MD5	`a028709b1236b7182536b88df0b6e8bf`
BLAKE2b-256	`27abfb45fd46c7dca01acbb58ef1a41a43da2ac56a57f88377a910f1ec7eda22`

See more details on using hashes here.

Provenance

The following attestation bundles were made for esgvoc-5.0.1.tar.gz:

Publisher: pypi-publish.yml on ESGF/esgf-vocab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: esgvoc-5.0.1.tar.gz
- Subject digest: 97d90ba8b38a35b13f16c08b166b0e2921b50c4d4cd20dd277cd505c3029fb94
- Sigstore transparency entry: 2291515921
- Sigstore integration time: Jul 30, 2026
Source repository:
- Permalink: ESGF/esgf-vocab@e0e0f55520c504720d94f1ccc22e6023f880f1d3
- Branch / Tag: refs/tags/5.0.1
- Owner: https://github.com/ESGF
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: pypi-publish.yml@e0e0f55520c504720d94f1ccc22e6023f880f1d3
- Trigger Event: release