Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.53 KB

README.md

File metadata and controls

49 lines (32 loc) · 2.53 KB
Raw

OpenMod4Africa workflow repository

Copyright 2022-2023 IIASA

Code style: black

Overview

The project template can be downloaded here: https://file.ece.iiasa.ac.at/openmod4africa/openmod4africa.xlsx.

This is repository contains the variable template and model mappings for the OpenMod4Africa project.

This project makes use of the nomenclature definition import feature and imports the openENTRANCE variable template. Only the variables are imported from openENTRANCE. For the regions the nomenclature functionality to automatically include all ISO 3166-1 countries is used.

Project nomenclature

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.

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.

Workflow

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.