Skip to main content

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.

license DOI python Code style: ruff pytest ReadTheDocs

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

pyam logo

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

openENTRANCE logo

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.

EU logo This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 835896.

Metadata

Release files for nomenclature-iamc 0.32.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nomenclature-iamc 0.32.1
File Size Uploaded Provenance Actions
nomenclature_iamc-0.32.1.tar.gz 54.3 kB With provenance Details for nomenclature_iamc-0.32.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nomenclature-iamc 0.32.1
File Interpreter ABI Platform Actions
nomenclature_iamc-0.32.1-py3-none-any.whl Python 3 none any Details for nomenclature_iamc-0.32.1-py3-none-any.whl

Total release size: 119.5 kB

Release files / nomenclature_iamc-0.32.1.tar.gz

Download URL nomenclature_iamc-0.32.1.tar.gz
Size 54.3 kB
Tags Source
SHA-256 checksum
How to use checksums
3df83d95bc17bd7b2d0754c2786b75b9e2eabbecd89c0ed5fe6b4d3663e5e27b
BLAKE2b-256 checksum
How to use checksums
cf9e442645994132d20dfa322dab20f156fc754fe712a9af6c59c2e8ac48ae71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 21, 2026.

Transparency log

Release files / nomenclature_iamc-0.32.1-py3-none-any.whl

Download URL nomenclature_iamc-0.32.1-py3-none-any.whl
Size 65.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a7d9dfd590575c1e1e83aeda84e21d1f44aa85f66d91d730228885e9634351e6
BLAKE2b-256 checksum
How to use checksums
51dc1adf5b5ff1619a906eb22c24ac3eab67528281ad372cc8e030241a17bfaf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 21, 2026.

Transparency log

Security for nomenclature-iamc 0.32.1

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for nomenclature_iamc-0.32.1.tar.gz

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 Oct 21, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.32.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page