Common definitions for model comparison projects

Overview

This repository holds definitions and mappings for model-comparison projects using the IAMC data format. The aim is to provide a central location to facilitate reuse of definitions and mappings across projects. Read more about the IAMC data format.

This project uses the Python package nomenclature-iamc for management of codelists and validation of scenario data in the IAMC data format.

[!TIP] For users not comfortable working with GitHub repositories and yaml files, the definitions for this project are available for download as an xlsx spreadsheet at https://files.ece.iiasa.ac.at/common-definitions/common-definitions-template.xlsx.

[!NOTE] You can generate the project region and variable template xlsx spreadsheet yourself!

1. Clone/download this repository
2. Install the Pyhon package nomenclature (pip install nomenclature-iamc)
3. Run $ nomenclature export-definitions . definitions.xlsx

Codelists and mappings

The folder definitions contains the "codelists", i.e., list of allowed variables and regions, for use in the validation workflow. In the IAMC community, the word "variable template" is also used to refer to the codelists for variables.

The folder mappings contains models-specific processing and automated aggregation of regions from "native model regions" (as reported by a model) to "common regions" used for comparison and analysis of results.

Model registration

This is the step-by-step guide to registering your model:

1. Fork this repository
2. Follow the instructions from the nomenclature documentation here: https://nomenclature-iamc.readthedocs.io/en/stable/user_guide/model-registration.html. Please make sure to follow the instructions completely, both the Model mapping and the Region definitions part. You'll have to end up with two files.
3. Open a pull request into this repository. Make sure that the tests pass and correct any potential issues.
4. Set @danielhuppmann and @phackstock as reviewers (or mention them in the pull request text).
5. Once everything is in order we will merge your pull request and your model will be registered.

Funding acknowledgement