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.

Project nomenclature

The folder definitions contains the project nomenclature, i.e., list of allowed variables and regions, for use in the validation workflow. See the nomenclature package for more information (link).

The folder mappings contains models-specific region-processing mappings.

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 run through and correct any potential issues. If the tests are failing you can view the details by clicking on the failed test run.

4. Set @danielhuppmann and @phackstock as reviewers.

5. Once everything is in order we will merge your pull request and your model will be registered.

Funding acknowledgement

This repository was started as part of the PRISMA project with funding from the European Union’s Horizon Europe programme under grant agreement No. 101081604 (PRISMA).