Add reporting of rocks for enhanced weathering and plots to cs2

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '231669480'
+ValidationKey: '231915900'
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'
 - 'Warning: namespace ''.*'' is not available and has been replaced'

.github/workflows/check.yaml

@@ -23,14 +23,14 @@ jobs:
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: |
-            any::lucode2
-            any::covr
-            any::madrat
-            any::magclass
-            any::citation
-            any::gms
-            any::goxygen
-            any::GDPuc
+            lucode2
+            covr
+            madrat
+            magclass
+            citation
+            gms
+            goxygen
+            GDPuc
           # piam packages also available on CRAN (madrat, magclass, citation,
           # gms, goxygen, GDPuc) will usually have an outdated binary version
           # available; by using extra-packages we get the newest version

CITATION.cff

@@ -2,8 +2,8 @@ cff-version: 1.2.0
 message: If you use this software, please cite it using the metadata from this file.
 type: software
 title: 'remind2: The REMIND R package (2nd generation)'
-version: 1.158.0
-date-released: '2024-10-10'
+version: 1.159.0
+date-released: '2024-10-14'
 abstract: Contains the REMIND-specific routines for data and model output manipulation.
 authors:
 - family-names: Rodrigues

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: remind2
 Title: The REMIND R package (2nd generation)
-Version: 1.158.0
-Date: 2024-10-10
+Version: 1.159.0
+Date: 2024-10-14
 Authors@R: c(
     person("Renato", "Rodrigues", , "[email protected]", role = c("aut", "cre")),
     person("Lavinia", "Baumstark", role = "aut"),

R/reportTechnology.R

@@ -356,7 +356,6 @@ reportTechnology <- function(gdx, output = NULL, regionSubsetList = NULL, t = c(
   ## delete "+" and "++" from variable names
   output <- deletePlus(output)
 
-
   # add global values ----
   map <- data.frame(region = getRegions(tmp), world = "GLO", stringsAsFactors = FALSE)
   y <- Reduce(intersect, list(getYears(tmp), getYears(output)))
@@ -390,6 +389,41 @@ reportTechnology <- function(gdx, output = NULL, regionSubsetList = NULL, t = c(
 
   tmp[is.na(tmp)] <- 0  # tmp is NA if weight is zero for all regions within the GLO or the specific region aggregation. Therefore, we replace all NAs with zeros.
 
+
+ # EW reporting: add info on rocks for enhanced weathering ----
+    tmp2 <- NULL
+    ## calculate totals of rocks spread 
+    v33_EW_onfield <- readGDX(gdx,"v33_EW_onfield", restore_zeros = F,field="l",format="first_found")[,t,] # [Gt rock]
+    v33_EW_onfield_total <- dimSums(v33_EW_onfield,dim=3)             # aggregate total rocks spread [Gt rock]
+    v33_EW_onfield_byClimateGrade <- dimSums(v33_EW_onfield,dim=3.2)  # rocks spread by climate grade, aggregated across transportation grades [Gt rock]
+
+    ## calculate totals of rocks weathering on fields in each period
+    v33_EW_onfield_tot <- readGDX(gdx,"v33_EW_onfield_tot", restore_zeros = F,field="l",format="first_found")[,t,] # [Gt rock]
+    v33_EW_onfield_tot_total <- dimSums(v33_EW_onfield_tot,dim=3)            # total of rocks weathering on fields  [Gt rock]
+    v33_EW_onfield_tot_byClimateGrade <- dimSums(v33_EW_onfield_tot,dim=3.2) # rocks weathering on field by climate grade, aggregated across transportation grades [Gt rock]
+
+    tmp2 <- mbind(
+        setNames(v33_EW_onfield_total                 * 1000,  "CDR|Rocks spread (Mt rocks/yr)"), 
+        setNames(v33_EW_onfield_byClimateGrade[,,"1"] * 1000,  "CDR|Rocks spread|+|warm regions (Mt rocks/yr)"),
+        setNames(v33_EW_onfield_byClimateGrade[,,"2"] * 1000,  "CDR|Rocks spread|+|temperate regions (Mt rocks/yr)"),
+        setNames(v33_EW_onfield_tot_total             * 1000,  "CDR|Rocks weathering (Mt rocks)"),
+        setNames(v33_EW_onfield_tot_byClimateGrade[,,"1"] * 1000,  "CDR|Rocks weathering|+|warm regions (Mt rocks)"),
+        setNames(v33_EW_onfield_tot_byClimateGrade[,,"2"] * 1000,  "CDR|Rocks weathering|+|temperate regions (Mt rocks)")
+    )
+
+    ## add global values
+    tmp2 <- mbind(tmp2, dimSums(tmp2, dim = 1))
+
+    if (!is.null(regionSubsetList))
+          tmp2 <- mbind(tmp2, calc_regionSubset_sums(tmp2, regionSubsetList))
+
+
+  # combine main reporting and EW ----
+    tmp2 <- magclass::matchDim(tmp2, tmp, dim=c(1,2))
+    tmp <- mbind(tmp,tmp2)  
+
+
   getSets(tmp)[3] <- "variable"
+
   return(tmp)
 }

README.md

@@ -1,6 +1,6 @@
 # The REMIND R package (2nd generation)
 
-R package **remind2**, version **1.158.0**
+R package **remind2**, version **1.159.0**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/remind2)](https://cran.r-project.org/package=remind2)  [![R build status](https://github.com/pik-piam/remind2/workflows/check/badge.svg)](https://github.com/pik-piam/remind2/actions) [![codecov](https://codecov.io/gh/pik-piam/remind2/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/remind2) [![r-universe](https://pik-piam.r-universe.dev/badges/remind2)](https://pik-piam.r-universe.dev/builds)
 
@@ -49,7 +49,7 @@ In case of questions / problems please contact Renato Rodrigues <renato.rodrigue
 
 To cite package **remind2** in publications use:
 
-Rodrigues R, Baumstark L, Benke F, Dietrich J, Dirnaichner A, Duerrwaechter J, Führlich P, Giannousakis A, Hasse R, Hilaire J, Klein D, Koch J, Kowalczyk K, Levesque A, Malik A, Merfort A, Merfort L, Morena-Leiva S, Pehl M, Pietzcker R, Rauner S, Richters O, Rottoli M, Schötz C, Schreyer F, Siala K, Sörgel B, Spahr M, Strefler J, Verpoort P, Weigmann P, Rüter T (2024). _remind2: The REMIND R package (2nd generation)_. R package version 1.158.0, <https://github.com/pik-piam/remind2>.
+Rodrigues R, Baumstark L, Benke F, Dietrich J, Dirnaichner A, Duerrwaechter J, Führlich P, Giannousakis A, Hasse R, Hilaire J, Klein D, Koch J, Kowalczyk K, Levesque A, Malik A, Merfort A, Merfort L, Morena-Leiva S, Pehl M, Pietzcker R, Rauner S, Richters O, Rottoli M, Schötz C, Schreyer F, Siala K, Sörgel B, Spahr M, Strefler J, Verpoort P, Weigmann P, Rüter T (2024). _remind2: The REMIND R package (2nd generation)_. R package version 1.159.0, <https://github.com/pik-piam/remind2>.
 
 A BibTeX entry for LaTeX users is
 
@@ -58,7 +58,7 @@ A BibTeX entry for LaTeX users is
   title = {remind2: The REMIND R package (2nd generation)},
   author = {Renato Rodrigues and Lavinia Baumstark and Falk Benke and Jan Philipp Dietrich and Alois Dirnaichner and Jakob Duerrwaechter and Pascal Führlich and Anastasis Giannousakis and Robin Hasse and Jérome Hilaire and David Klein and Johannes Koch and Katarzyna Kowalczyk and Antoine Levesque and Aman Malik and Anne Merfort and Leon Merfort and Simón Morena-Leiva and Michaja Pehl and Robert Pietzcker and Sebastian Rauner and Oliver Richters and Marianna Rottoli and Christof Schötz and Felix Schreyer and Kais Siala and Björn Sörgel and Mike Spahr and Jessica Strefler and Philipp Verpoort and Pascal Weigmann and Tonn Rüter},
   year = {2024},
-  note = {R package version 1.158.0},
+  note = {R package version 1.159.0},
   url = {https://github.com/pik-piam/remind2},
 }
 ```

inst/compareScenarios/cs_03_emissions.Rmd

@@ -383,6 +383,14 @@ cdrVars <-
 walk(cdrVars, showLinePlots, data = data)
 ```
 
+#### EW rock spreading
+```{r CO2 EW rock}
+items <- c(
+  "CDR|Rocks spread",
+  "CDR|Rocks weathering"
+)
+walk(items, showLinePlots, data = data)
+```
 
 ### Cumulated Emissions