Copyright 2026 IIASA
This repository contains the workflow and configuration for the IAM Diagnostics.
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/iam-diagnostics/iam-diagnostics-template.xlsx.
Important
This workflow repository uses definitions and region mappings from the
common-definitions repository.
Check out nomenclature.yaml for the specific configuration.
This code collects information on models, scenarios and variables that will be used in the IAMC diagnostic exercise. Many teams are probably already registered in the common-definitions repository, and will therefore be using this repository limitedly. If you have not participated in previous IAM MIPs before, read the guidance below to add your model registration, but also important regional mappings that greatly help the analysis. Feel free to reach out to Mark Dekker for general questions. For more information the exercise, see the protocol for the scenarios, or the [announcement] (https://www.iamconsortium.org/iamc-announcements/invitation-iam-diagnostic-exercise/) on the IAMC website.
The folder definitions can contain 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 can contain model mappings that are used to register models and
define how results should be processed upon upload to a Scenario Explorer.
This is the step-by-step guide to registering your model:
-
Fork this repository
-
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.
-
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.
-
Set @danielhuppmann and @phackstock as reviewers.
-
Once everything is in order we will merge your pull request and your model will be registered.
The module workflow.py has a function main(df: pyam.IamDataFrame) -> pyam.IamDataFrame:.
Per default, this function takes an IamDataFrame and returns it without modifications. Read the docs for more information about the pyam package for scenario analysis and data visualization.
Important: Do not change the name of the module workflow.py or the function main
as they are called like this by the Job Execution Service. Details can be found
here.