lauwien / nomenclature

A package to work with IAMC-style variable templates

nomenclature - Working with IAMC-style data templates

Copyright 2021 IIASA

This repository is licensed under the Apache License, Version 2.0 (the "License"); see the LICENSE for details.

Overview

This package facilitates working with data templates that follow the format developed by the Integrated Assessment Modeling Consortium (IAMC). It supports validation of scenario data and region processing, which consists of renaming and aggregation of model "native regions" to "common regions" used in a project. It requires Python version >= 3.8.

The full documentation is hosted on Read the Docs

The pyam package

This package is intended to complement the Python package pyam, an open-source community toolbox for analysis & visualization of scenario data. That 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 projects.

Read the docs for more information!

Getting started

To install this package, please install Python version 3.8 or higher. Nomenclature is on 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

Then, open a Python console and import a suitable nomenclature structure from a folder and run the following code to inspect the variables defined in the nomenclature.

import nomenclature
project = nomenclature.DataStructureDefinition("path/to/definition/folder")
project.variable

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/nomenclature repository for more information.

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