Copyright 2022-2024 IIASA
This is a template for project-specific scenario processing workflows.
To use this template for a project, do the following:
- Create a new repository from this template
- Update the title and overview section of this Readme
- Start adding definitions and mappings
- If you want to use the common-definitions
developed and maintained by the IAMC, rename the file
nomenclature_template.yamltonomenclature.yaml.
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.