Copyright 2024 IIASA and the iDesignRES consortium
This work is licensed under CC BY 4.0
The Horizon Europe project iDesignRES offers state-of-the-art open-source toolboxes empowering public authorities and network operators to plan and optimise renewable energy systems from regional to European scales.
Visit https://idesignres.eu for more information about the project!
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 project mostly uses the variables from the common-definitions repository, an initiative by the IAMC to develop a shared list of definitions across projects. to faciliate interoperability and reuse of scenario data.
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 http://files.ece.iiasa.ac.at/idesignres/idesignres-template.xlsx.
The folder definitions can contain the project-specific codelists, 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.
This project builds on the work in the Horizon 2020 projects openENTRANCE and ECEMF.
Visit https://github.com/openENTRANCE/openentrance for more information!
