nomenclature - Working with IAMC-format project definitions
Copyright 2021-2023 IIASA
This repository is licensed under the Apache License, Version 2.0 (the "License"); see the LICENSE for details.
Overview
The nomenclature package facilitates validation and processing of scenario data. It allows managing definitions of data structures for model comparison projects and scenario analysis studies using the data format developed by the Integrated Assessment Modeling Consortium (IAMC).
A data structure definition consists of one or several "codelists". A codelist is a list of allowed values (or "codes") for dimensions of IAMC-format data, typically regions and variables. Each code can have additional attributes: for example, a "variable" has to have an expected unit and usually has a description. Read the SDMX Guidelines for more information on the concept of codelists.
The nomenclature package supports three main use cases:
- Management of codelists and mappings for model comparison projects
- Validation of scenario data against the codelists of a specific project
- Processing of scenario results, e.g. aggregation and renaming from "native regions" of a model to "common regions" (i.e., regions that are used for scenario comparison in a project).
The documentation is hosted on Read the Docs.
Integration with the pyam package
The nomenclature package is designed to complement the Python package pyam, an open-source community toolbox for analysis & visualization of scenario data. The pyam package was developed to facilitate working with timeseries scenario data conforming to the format developed by the IAMC. It is used in ongoing assessments by the IPCC and in many model comparison projects at the global and national level, including several Horizon 2020 & Horizon Europe projects.
The validation and processing features of the nomenclature package work with scenario data as a pyam.IamDataFrame object.
Read the pyam Docs for more information!
Getting started
To install the latest release of the package, please use the following command:
pip install nomenclature-iamc
Alternatively, it can also be installed directly from source:
pip install -e git+https://github.com/IAMconsortium/nomenclature#egg=nomenclature-iamc
See the User Guide for the main use cases of this package.
Acknowledgement
This package is based on the work initially done in the Horizon 2020 openENTRANCE project, which aims to develop, use and disseminate an open, transparent and integrated modelling platform for assessing low-carbon transition pathways in Europe.
Refer to the openENTRANCE/openentrance repository for more information.
3 maintainers
Metadata
3 maintainers
Release files for nomenclature-iamc 0.32.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 | |
|---|---|---|---|
| nomenclature_iamc-0.32.0.tar.gz | 54.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nomenclature_iamc-0.32.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 119.5 kB
Release files / nomenclature_iamc-0.32.0.tar.gz
| Download URL | nomenclature_iamc-0.32.0.tar.gz |
|---|---|
| Size | 54.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
97d98c4ae95067e8e712fbc66a9e9893c2e58d254abc021ee36142a01c6cb3b4
|
|
BLAKE2b-256 checksum How to use checksums |
14fb634b3bcdf26fd365e8764ec201a1c8d4e36408030dc5d4ee2b11a7ea9d93
|
| 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 16, 2026.
Transparency logRelease files / nomenclature_iamc-0.32.0-py3-none-any.whl
| Download URL | nomenclature_iamc-0.32.0-py3-none-any.whl |
|---|---|
| Size | 65.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
155dc515932d9236a9b7953387b2a811898b01f99aa19e3c04125553535b11d8
|
|
BLAKE2b-256 checksum How to use checksums |
a5c027a869a654e84d3087a0530bae79e8d8b2373e881c314f390cee74032fc6
|
| 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 16, 2026.
Transparency log
