Merge pull request #2078 from LaviniaBaumstark/REMINDrelease3p5p0

remind release 3.5.0

Author: LaviniaBaumstark

.Rprofile

@@ -6,30 +6,8 @@ Sys.setenv(RENV_PATHS_LIBRARY = "renv/library")
 # do not check if library and renv.lock are in sync, because normally renv.lock does not exist
 options(renv.config.synchronized.check = FALSE)
 
-# always set the renv project to the current directory
-Sys.setenv("RENV_PROJECT" = getwd())
-
-# when increasing renvVersion first commit new version's activate script and
-# put that commit's hash into the git checkout call below
-renvVersion <- "1.0.7"
-
-# reset renv/activate.R to match renv 1.0.7
-gitRoot <- system2("git", c("rev-parse", "--show-toplevel"), stdout = TRUE)
-if (Sys.getenv("RESET_RENV_ACTIVATE_SCRIPT", unset = "TRUE") == "TRUE" &&
-      normalizePath(gitRoot) == normalizePath(".")) {
-  system2("git", c("checkout", "b83bb1811ff08d8ee5ba8e834af5dd0080d10e66", "--", "renv/activate.R"))
-}
-
 source("renv/activate.R")
 
-if (packageVersion("renv") != renvVersion) {
-  renvLockExisted <- file.exists(renv::paths$lockfile())
-  renv::install(paste0("renv@", renvVersion))
-  if (!renvLockExisted) {
-    unlink(renv::paths$lockfile())
-  }
-}
-
 if (!"https://rse.pik-potsdam.de/r/packages" %in% getOption("repos")) {
   options(repos = c(getOption("repos"), pik = "https://rse.pik-potsdam.de/r/packages"))
 }

.github/workflows/size-check

@@ -14,4 +14,4 @@ maxfilesize <- function(max) {
   message("All files are smaller than ", max, "kB\n")
 }
 
-maxfilesize(250)
+maxfilesize(550)

.gitignore

@@ -19,6 +19,7 @@
 
 # Ignore everything in "input" folders
 input/
+!input/files
 !/scripts/input/
 
 # Ignore everything in root "output" folder
@@ -88,3 +89,4 @@ calibration_results/
 
 # ignore test logs
 tests/test-full*.log
+tests/testthat/C_TESTTHAT_startlog_*.txt

CHANGELOG.md

@@ -4,22 +4,67 @@
 All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+
+## [3.5.0] - 2025-04-04
+
+### added
+- Possibility of using updated sources for baseline non-CO2 emissions calculation, controlled by `cm_emifacs_baseyear`
+- Add `readcoupled` script that allows to print data from gdx files or mif files for all coupled runs
+    [[#1977](https://github.com/remindmodel/remind/pull/1977), [#1990](https://github.com/remindmodel/remind/pull/1990)]
+- Add `scripts/start/checkSettingsRemMag.R` to check compatibility of REMIND and MAgPIE settings with respect
+  to GDP, Population, bioenergy phaseout and damage settings
+    [[#2028](https://github.com/remindmodel/remind/pull/2028)]
+
+### input data/calibration
+- new input data rev7.21 including new MAgPIE data [[#1956](https://github.com/remindmodel/remind/pull/1956)]
+- new input data rev7.24 including IEA update [[#1992](https://github.com/remindmodel/remind/pull/1992)]
+- add CES parameters for SSP3 with imperfect capital markets [[#1995](https://github.com/remindmodel/remind/pull/1995)] 
+
+### changed
+- **config** updated ScenarioMIP config
+    [[#1972](https://github.com/remindmodel/remind/pull/1972)]
+- **scripts** for MAgPIE coupled runs, if the coupled config contains a `path_gdx_ref` column, it needs a `path_gdx_refpolicycost` column as well.
+    [[#1940](https://github.com/remindmodel/remind/pull/1940)]
+- **scripts** make the selection of variables and equations that are fixed on reference run automatic
+    [[#2033](https://github.com/remindmodel/remind/pull/2033)]
+-_**scripts** You can define timesteps in xlsx_IIASA export script. Defaults to REMIND standard. If you want interpolation between timesteps,
+    you need to adjust it. [[#2056](https://github.com/remindmodel/remind/pull/2056)]
+- **core** merge cm_GDPscen and cm_POPscen into cm_GDPpopScen
+    [[#1973](https://github.com/remindmodel/remind/pull/1973)]
+- **45_carbonprice** realization 'none' only sets carbon price to 0 for t >= cm_startyear
+    [[#2056](https://github.com/remindmodel/remind/pull/2056)]
+- **scripts** Updated renv version from to 1.1.1 to 1.1.4
+    [[#2065](https://github.com/remindmodel/remind/pull/2065)]
+- **scripts** let the release script add a renv.lock to each new release
+    [[#2058](https://github.com/remindmodel/remind/pull/2058)]
+
+### added
+-
+
+### removed
+- **37_industry** removed superseded realization fixed_shares [[#1941](https://github.com/remindmodel/remind/pull/1941)]
+- last traces of SSP2EU scenario which is superseeded by SSP2 [[#2028](https://github.com/remindmodel/remind/pull/2028)]
+
+### fixed
+- **37_industry** fix and restructure chemical feedstock balancing to account for all negative emissions from stored non-fossil carbon [[#1829](https://github.com/remindmodel/remind/pull/1829)]
+
+
 ## [3.4.0] - 2024-12-11
 
 ### input data/calibration
 - new input data rev6.84 [[#1757](https://github.com/remindmodel/remind/pull/1757)]
-- new input data rev6.95 in US$2017[[#1812]] (https://github.com/remindmodel/remind/pull/1812) 
-- new input data rev7.13 including new MAgPIE emulators [[#1886]] (https://github.com/remindmodel/remind/pull/1886)
+- new input data rev6.95 in US$2017 [[#1812](https://github.com/remindmodel/remind/pull/1812)]
+- new input data rev7.13 including new MAgPIE emulators [[#1886](https://github.com/remindmodel/remind/pull/1886)]
 - CES parameter and gdx files calibrated with new default diffLin2Lin for NPi 
     [[#1747](https://github.com/remindmodel/remind/pull/1747)] and
     [[#1757](https://github.com/remindmodel/remind/pull/1757)]
 - Update of NDC goals with cutoff data August 31, 2024
     [[#1816](https://github.com/remindmodel/remind/pull/1816)]
 - Prepare to make input data available for externals. Do not stop on missing validation data.
-  [[1828]][(https://github.com/remindmodel/remind/pull/1828)]
+    [[1828](https://github.com/remindmodel/remind/pull/1828)]
 
 ### changed
-- shift base unit from US$2005 to US$2017 [[#1812]] (https://github.com/remindmodel/remind/pull/1812)
+- shift base unit from US$2005 to US$2017 [[#1812](https://github.com/remindmodel/remind/pull/1812)]
 - plastic waste by default does not lag plastics production by ten years
     anymore; can be re-activated using `cm_wastelag`
 - moved to edgeTransport 2.0 version [[#1749](https://github.com/remindmodel/remind/pull/1749)]
@@ -148,7 +193,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - **scripts** add script to automatically check project summations from piamInterfaces
     [[#1587](https://github.com/remindmodel/remind/pull/1587)]
 - **scripts** add MAGICCv7.5.3 with AR6 settings as output script, add compareScenarios2 option
-    [[#1475](https://github.com/remindmodel/remind/pull/1475), [[#1615](https://github.com/remindmodel/remind/pull/1615)]
+    [[#1475](https://github.com/remindmodel/remind/pull/1475)], [[#1615](https://github.com/remindmodel/remind/pull/1615)]
 - **scripts** add 'make test-fix' which runs codeCheck in interactive mode, adjusting not_used.txt files
     [[#1625](https://github.com/remindmodel/remind/pull/1625)]
 - **testthat** test and compile all config files [[#1356](https://github.com/remindmodel/remind/pull/1356)]

CITATION.cff

@@ -49,6 +49,16 @@ authors:
   given-names:  "Cornelia"
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Bantje"
+  given-names:  "David"
+  orcid: https://orcid.org/0009-0005-8875-9496
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
+- family-names: "Beier"
+  given-names:  "Felicitas"
+  orcid: https://orcid.org/0000-0002-8725-7663
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Benke"
   given-names: "Falk"
   affiliation: "Potsdam Institute for Climate Impact Research"
@@ -67,6 +77,11 @@ authors:
   orcid: https://orcid.org/0000-0002-3240-2608
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Dorndorf"
+  given-names:  "Tabea"
+  orcid: https://orcid.org/0000-0003-1824-898X
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Duerrwaechter"
   given-names:  "Jakob"
   orcid: https://orcid.org/0000-0001-8961-5340
@@ -92,6 +107,11 @@ authors:
   orcid: https://orcid.org/0000-0002-6406-6266
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Hagen"
+  given-names:  "Alex"
+  orcid: https://orcid.org/0000-0003-4793-8664
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Haller"
   given-names:  "Markus"
 
@@ -100,13 +120,22 @@ authors:
   orcid: https://orcid.org/0000-0003-1818-3186
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Hayez"
+  given-names:  "Léa"
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Hilaire"
   given-names:  "Jerome"
   orcid: https://orcid.org/0000-0002-9879-6339
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Hofbauer"
+  given-names:  "Verena"
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Hoppe"
   given-names:  "Johanna"
+  orcid: https://orcid.org/0009-0004-6753-5090
   affiliation: "Potsdam Institute for Climate Impact Research"
 
 - family-names: "Klein"
@@ -135,6 +164,11 @@ authors:
   given-names:  "Elmar"
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Lécuyer"
+  given-names:  "Fabrice"
+  orcid: https://orcid.org/0000-0002-7364-999X
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Levesque"
   given-names:  "Antoine"
   affiliation: "Potsdam Institute for Climate Impact Research"
@@ -179,6 +213,11 @@ authors:
 - family-names: "Mouratiadou"
   given-names:  "Ioanna"
 
+- family-names: "Müßel"
+  given-names:  "Jarusch"
+  orcid: https://orcid.org/0000-0002-1857-7866
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Odenweller"
   given-names:  "Adrian"
   orcid: https://orcid.org/0000-0002-1123-8124
@@ -218,6 +257,11 @@ authors:
 - family-names: "Roming"
   given-names:  "Niklas"
 
+- family-names: "Rosemann"
+  given-names:  "Ricarda"
+  orcid: https://orcid.org/0009-0006-5939-3197
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Rottoli"
   given-names:  "Marianna"
   affiliation: "Potsdam Institute for Climate Impact Research"
@@ -226,6 +270,16 @@ authors:
   given-names:  "Tonn"
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Salzwedel"
+  given-names:  "Robert"
+  orcid: https://orcid.org/0000-0002-7614-9210
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
+- family-names: "Sauer"
+  given-names:  "Pascal"
+  orcid: https://orcid.org/0000-0002-6856-8239
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Schmidt"
   given-names:  "Eva"
 
@@ -243,6 +297,11 @@ authors:
   given-names:  "Anselm"
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Sitarz"
+  given-names:  "Joanna"
+  orcid: https://orcid.org/0000-0002-8060-1097
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 - family-names: "Sörgel"
   given-names:  "Björn"
   orcid: https://orcid.org/0000-0002-2630-7081
@@ -262,6 +321,10 @@ authors:
   orcid: https://orcid.org/0000-0001-8801-173X
   affiliation: "Potsdam Institute for Climate Impact Research"
 
+- family-names: "Weiss"
+  given-names:  "Bennet"
+  affiliation: "Potsdam Institute for Climate Impact Research"
+
 title: REMIND - REgional Model of INvestments and Development
 abstract: REMIND (REgional Model of Investment and Development) is a numerical
   open source model that represents the future evolution of the world economies
@@ -271,8 +334,8 @@ abstract: REMIND (REgional Model of Investment and Development) is a numerical
   technology, policy and climate constraints. It also accounts for regional trade 
   characteristics on goods, energy fuels, and emissions allowances. All greenhouse 
   gas emissions due to human activities are represented in the model.
-version: 3.4.0
-date-released: 2024-12-11
+version: 3.5.0
+date-released: 2025-04-04
 repository-code: https://github.com/remindmodel/remind
 keywords:
   - energy

DESCRIPTION

@@ -3,7 +3,8 @@ Title: REMIND - REgional Model of INvestments and Development
 Version: 0.1
 Date: 2024-07-04
 Description: This is not a package yet, the purpose of this file is to
-    document metadata, notably dependencies.
+    document metadata, notably dependencies required by the R scripts.
+    Initialization of the renv will be based on this DESCRIPTION file.
 License: file LICENSE
 URL: https://github.com/remindmodel/remind,
     https://doi.org/10.5281/zenodo.6794920
@@ -17,15 +18,15 @@ Imports:
     data.table,
     devtools,
     dplyr,
-    edgeTransport (>= 2.7.0),
+    edgeTransport (>= 2.14.1),
     reporttransport (>= 0.5.0),
     flexdashboard,
     GDPuc,
     gdx (>= 1.53.0),
     gdxdt,
     gdxrrw,
     ggplot2,
-    gms (>= 0.33.0),
+    gms (>= 0.33.4),
     goxygen (>= 1.4.4),
     gridExtra,
     gtools,
@@ -45,16 +46,11 @@ Imports:
     magpiesets,
     mip (>= 0.150.0),
     modelstats,
-    mrremind (>= 0.191.2),
-    mrcommons (>= 1.43.6),
-    mrdrivers (>= 3.0.0),
-    mrtransport (>= 0.7.1),
-    mrvalidation,
     ncdf4,
     nleqslv,
     optparse,
     piamenv (>= 0.6.0),
-    piamInterfaces (>= 0.34.1),
+    piamInterfaces (>= 0.48.1),
     piamPlotComparison (>= 0.0.10),
     piamutils,
     plotly,
@@ -64,8 +60,8 @@ Imports:
     raster,
     readr,
     readxl,
-    remind2 (>= 1.156.1),
-    renv,
+    remind2 (>= 1.167.0),
+    renv (>= 1.1.1),
     reshape2,
     reticulate,
     rlang,
@@ -74,7 +70,7 @@ Imports:
     SPEI,
     stringr,
     terra,
-    testthat (>= 3.2.0),
+    testthat (>= 3.2.3),
     tibble,
     tidyr,
     tidyverse,

Makefile

@@ -26,7 +26,7 @@ update-renv:     ## Upgrade all pik-piam packages in your renv to the respective
 
 update-renv-all: ## Upgrade all packages (including CRAN packages) in your renv
                  ## to the respective latest release, write renv.lock archive
-	@Rscript -e 'renv::update(exclude = "renv"); piamenv::archiveRenv()'
+	@Rscript -e 'renv::update(); piamenv::archiveRenv()'
 
 revert-dev-packages: ## All PIK-PIAM packages that are development versions, i.e.
                      ## that have a non-zero fourth version number component, are
@@ -39,6 +39,14 @@ ensure-reqs:     ## Ensure the REMIND library requirements are fulfilled
                  ## install updates unless it is required.
 	@Rscript -e 'source("scripts/start/ensureRequirementsInstalled.R"); ensureRequirementsInstalled(rerunPrompt="make ensure-reqs")'
 
+historic-reqs:   ## Restore renv.lock file "v" from the lockfile archive.  Call
+                 ## make historic-reqs v=YYYY-MM-DD
+                 ## where YYYY-MM-DD is a date tag in the lockfile archive.
+                 ## Uses environment variable RSE_LOCKFILE_ARCHIVE, or if that
+                 ## is unset /p/projects/rd3mod/github/repos/pik-piam/lockfile-archive/main/
+	@[ -n "$(v)" ] || ( echo "no date tag \"v\" set to restore renv.lock"; exit 1 )
+	@mkdir -p renv/archive && git -C $${RSE_LOCKFILE_ARCHIVE:-/p/projects/rd3mod/github/repos/pik-piam/lockfile-archive/main/} show $(v):./conservative.renv.lock > renv/archive/$(v)_renv.lock && Rscript -e "renv::restore(lockfile = \"renv/archive/$(v)_renv.lock\", exclude = \"renv\")"
+
 archive-renv:    ## Write renv.lock into archive.
 	Rscript -e 'piamenv::archiveRenv()'