Copyright 2024 IIASA

This work is licensed under CC BY 4.0

ECEMF is a Horizon 2020 funded project whose aim is to establish a European forum for energy and climate researchers and policy makers to achieve climate neutrality.
Visit https://ecemf.eu for more information!

This workflow repository includes the workflow for scenario processing and validation using the database infrastructure developed by the IIASA Scenario Services & Scientific Software team. Read more at https://docs.ece.iiasa.ac.at!

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:

1. Fork this repository

2. Follow the instructions from the nomenclature documentation to register your model.
   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.

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.

This project builds on the work in the Horizon 2020 project openENTRANCE.
Visit https://github.com/openENTRANCE/openentrance for more information!