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
2 maintainers
Metadata
2 maintainers
Release files for esgvoc 6.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| esgvoc-6.0.0.tar.gz | 5.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| esgvoc-6.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 5.9 MB
Release files / esgvoc-6.0.0.tar.gz
| Download URL | esgvoc-6.0.0.tar.gz |
|---|---|
| Size | 5.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
83c7074698487322334be1e4cdcd2510d21eb3486fb740deb509bf04515dc8bf
|
|
BLAKE2b-256 checksum How to use checksums |
4e1dc86ed68655b5792d561a5ce0499839c553d30e3e5d12c225a94e630b2a5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / esgvoc-6.0.0-py3-none-any.whl
| Download URL | esgvoc-6.0.0-py3-none-any.whl |
|---|---|
| Size | 249.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1505cbeb1750593fb6ace54f7b8e731019862182fcffaf54d6b62b1b06eab356
|
|
BLAKE2b-256 checksum How to use checksums |
a280f31a5323f216230b162e25ecf7daf9565ed6cc7c01aa57cd0598b26c1885
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency log
