Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MESSAGE model versioning names as used in AR6DB #228

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jkikstra
Copy link
Contributor

Adds model versioning names similar to those in the AR6 Scenarios Database; for documentation especially of older versions.

How to review

Check if anything is wrong.
Decide if we need to also add more information from those that used these model versions before merging.

Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.5%. Comparing base (32cb2fd) to head (ff83021).

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #228   +/-   ##
=====================================
  Coverage   59.5%   59.5%           
=====================================
  Files        195     195           
  Lines      15491   15491           
=====================================
  Hits        9225    9225           
  Misses      6266    6266           

@khaeru khaeru added doc Improvements or additions to documentation enh New features or functionality labels Sep 12, 2024
@@ -313,6 +313,12 @@ postfix

Some external model names include:

MESSAGE V.3
.. todo:: Expand with a list of cases in which this model name has been used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the PR title/description, it sounds like the AR6 database is a case in which this model name has been used. If so, why not record that here?

@@ -324,6 +330,9 @@ MESSAGEix-GLOBIOM 1.1

.. todo:: Expand with a list of cases in which this model name has been used.

MESSAGEix-GLOBIOM 1.2
This version was used in <https://doi.org/10.1038/s41560-021-00904-8>, and is similar to MESSAGEix-GLOBIOM 1.1, but incorporates COVID effects and has annual timesteps from 2020 to 2025.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add additional citations to doc/main.bib and cite; see the example of the rest of the docs.

.. todo:: Expand with a list of cases in which this model name has been used.

MESSAGEix-GLOBIOM_GEI 1.0
.. todo:: Expand with a list of cases in which this model name has been used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation enh New features or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants