Package: remind2 2.2.2

Renato Rodrigues

remind2: The REMIND R package (2nd generation)

Contains the REMIND-specific routines for data and model output manipulation.

Authors:Renato Rodrigues [aut, cre], Lavinia Baumstark [aut], Falk Benke [aut], David Bantje [aut], Jan Philipp Dietrich [aut], Alois Dirnaichner [aut], Tabea Dorndorf [aut], Jakob Duerrwaechter [aut], Pascal Führlich [aut], Anastasis Giannousakis [aut], Robin Hasse [aut], Jérome Hilaire [aut], David Klein [aut], Johannes Koch [aut], Katarzyna Kowalczyk [aut], Fabrice Lécuyer [aut], Antoine Levesque [aut], Aman Malik [aut], Anne Merfort [aut], Leon Merfort [aut], Simón Morena-Leiva [aut], Michaja Pehl [aut], Robert Pietzcker [aut], Sebastian Rauner [aut], Oliver Richters [aut], Marianna Rottoli [aut], Tonn Rüter [aut], Robert Salzwedel [aut], Christof Schötz [aut], Felix Schreyer [aut], Kais Siala [aut], Björn Sörgel [aut], Mike Spahr [aut], Jessica Strefler [aut], Philipp Verpoort [aut], Pascal Weigmann [aut]

remind2_2.2.2.tar.gz
remind2_2.2.2.zip(r-4.7)remind2_2.2.2.zip(r-4.6)remind2_2.2.2.zip(r-4.5)
remind2_2.2.2.tgz(r-4.6-any)remind2_2.2.2.tgz(r-4.5-any)
remind2_2.2.2.tar.gz(r-4.7-any)remind2_2.2.2.tar.gz(r-4.6-any)
remind2_2.2.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
remind2/json (API)

# Install 'remind2' in R:
install.packages('remind2', repos = c('https://pik-piam.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/pik-piam/remind2/issues

On CRAN:

Conda:

7.56 score 167 scripts 60 exports 201 dependencies

Last updated from:b36fc68843. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK341
source / vignettesOK332
linux-release-x86_64OK281
macos-release-arm64OK212
macos-oldrel-arm64OK176
windows-develOK266
windows-releaseOK217
windows-oldrelOK224
wasm-releaseOK233

Exports:calc_CES_marginalscalc_regionSubset_sumscalcPricecheckVsCalibDatacolorScenConfcompareCalibrationTargetscompareScenarios2compareScenConfconvGDX2CSV_LCOEconvGDX2MIFconvGDX2MIF_LCOEconvGDX2MIF_REMIND2MAgPIEcreateVarListHtmldeletePlusexoGAINS2025AirPollutantsget_total_efficienciesgetCfgDefaultPathgetCfgScenPathgetCs2ProfilesgetMifHistPathgetMifScenPathgetRunsMIFGDXloadCs2DataloadModeltestnashConvergenceReportplotLCOEplotNashConvergenceread.reportEntryreadAllreadPVPreadSupplycurveBioreportAirPollutantEmissionsreportCapacityreportCapitalStockreportClimatereportCostsreportCrossVariablesreportEmireportEmiForClimateAssessmentreportEmploymentreportExtractionreportExtraEmissionsreportFEreportInvestmentsreportLCOEreportMacroEconomyreportMOFEXreportPEreportPolicyCostsreportPricesreportSDPVariablesreportSEreportTaxreportTechnologyreportTradeswitchValuesScenConftest_rangestime_cumulatetoolRegionSubsetsvariablesAsList

Dependencies:abindaskpassassertrbackportsbase64encbitbit64brewbriobslibcachemcallrcellrangercheckmatecitationclicliprclustercodetoolscollectionscolorspacecommonmarkcountrycodecpp11crayoncredentialscrosstalkcurldata.tabledescdevtoolsdiffobjdigestdotCall64downlitdplyrellipsisevaluatefansifarverfastmapfieldsfilelockfontawesomeforcatsforeignFormulafsgamstransferGDPucgdxgdx2gdxrrwgenericsgeometrygertggplot2gitcredsgluegmsgridExtragtablehighrHmischmshtmlTablehtmltoolshtmlwidgetshttpuvhttrhttr2igraphiniisobandjquerylibjsonlitekableExtraKernSmoothknitrlabelinglaterlatticelazyevallifecyclelinproglintrlpSolvelubridatelucode2luplotluscalelusweavemadratmagclassmagicmagpie4magpiesetsmagrittrmapsMASSMatrixmemoisemimeminiUImipmstoolsnnetnonparaeffopensslopenxlsxotelpakpiamInterfacespiamPlotComparisonpiamutilspillarpkgbuildpkgconfigpkgdownpkgloadplotlyplyrpraiseprettyunitsprocessxprofvisprogresspromisespspurrrqualVquitteR.methodsS3R.ooR.utilsR6raggrappdirsrasterrcmdcheckRColorBrewerRcppRcppProgressreadrreadxlrematchremulatorrenvreshape2rexrlangrmarkdownroxygen2rpartrprojrootrstudioapirversionsrworldmapS7sassscalessessioninfoshinysourcetoolsspspamstringistringrsvglitesyssystemfontsterratestthattextshapingtibbletidyrtidyselecttimechangetinytextrafficlighttzdburlcheckerusethisutf8vctrsviridisLitevroomwaldowhiskerwhoamiwithrwritexlxfunxml2xmlparsedataxopenxtableyamlymlthiszipzoo

remind2 reporting
Function | Development | Automated testing through buildLibrary and backwards compatibility | REMIND Variable Naming
Rendered fromremind2_reporting.Rmdusingknitr::rmarkdown

Last update: 2026-03-31
Started: 2022-05-31

compareScenarios in remind2
Overview | Usage | Via output script in REMIND | Via direct function call | Interactive use of the Rmd-files | Using outputFormat = "Rmd" | Using a cloned remind2 repository | Profiles | Existing profiles | Changing or Adding Profiles | Viewing variables available in mif Files | Via package function in remind2 | How to add a new plot to remind2 | Preprocessing | Further Info
Rendered fromcompareScenariosRemind2.Rmdusingknitr::rmarkdown

Last update: 2025-04-10
Started: 2024-04-30

Adding plots to the REMIND_summary.pdf
Learning objectives | Introduction | Call the (untouched) function | Get the code | Code chunk of a single plot | Area plot | Line plot | Manually executing parts of the function | Add a new plot | Rebuild the package | Generate a pdf containing the new plot | Commit your changes to the repository
Rendered fromremind_summary.Rmdusingknitr::rmarkdown

Last update: 2024-09-26
Started: 2019-08-01

Readme and manuals

Help Manual

Help pageTopics
The REMIND R package (2nd generation)remind2-package remind2
Calculate CES Marginalscalc_CES_marginals
Calculate Sums for Region Subsetscalc_regionSubset_sums
Calculates normalized prices of a commoditycalcPrice
Render checkVsCalibDatacheckVsCalibData
take scenario-config*.csv files and produce colorful xlsx file with values from main.gms in first row, identical values in this column in turquoise, and unknown column names in redcolorScenConf
Render compareCalibrationTargetscompareCalibrationTargets
Render CompareScenarios2compareScenarios2
take two REMIND scenario-config*.csv files and print the difference, comparing it to a default.cfg Can also be used for piamInterfaces mapping files with row.names=NULL and expanddata=FALSE.compareScenConf
Read in GDX and write LCOE .csv reportingconvGDX2CSV_LCOE
Read in GDX and write *.mif reportingconvGDX2MIF
Read in GDX and write LCOE .mif reportingconvGDX2MIF_LCOE
Read in GDX and write *.mif short reporting for REMIND-MAgPIE couplingconvGDX2MIF_REMIND2MAgPIE
Create an HTML Document of a Hierarchical List of VariablescreateVarListHtml
dimSumsdimSums
Helper to download auxiliary file needed for reporting from RSE serverdownloadAuxiliaryFile
Calculate projected air pollutant emissions at the level of GAINS sectors based on REMIND activities, GAINS emission factors, and baseyear (2020) emissionsexoGAINS2025AirPollutants
Get CES Total Efficienciesget_total_efficiencies
Get Paths to Certain Files in the REMIND DirectorygetCfgDefaultPath getCfgScenPath getMifHistPath getMifScenPath
Copy fulldata.gdx and mif files from a suite of runs into one folder. This function creates the folder "./data/" in your working directory if such folder does not exist. It will furthermore create a subfolder with the experiment name where the gdx and mif-files will be copied to. Care: If this subfolder is already existing, old files in this subfolder will be overwritten!getRunsMIFGDX
Load compareScenarios DataloadCs2Data
Load Modeltest ResultsloadModeltest
Modify Investment VariablesmodifyInvestmentVariables
Nash Convergence ReportnashConvergenceReport
Read in LCOE mif and write LCOE_plots.pdfplotLCOE
Creates a REMIND convergence overviewplotNashConvergence
Read entry in file of report formatread.reportEntry
readAllreadAll
Read PVP ("Present value price") from GDX filereadPVP
Read bioenergy supplycurve from GDXreadSupplycurveBio
Read in GDX, GAINS2025 emission factors and baseyear emissions and calculate air pollution emissions, used in convGDX2MIF.R for the reportingreportAirPollutantEmissions
Read in GDX and calculate capacities, used in convGDX2MIF.R for the reportingreportCapacity
Read in GDX and calculate capital stocks, used in convGDX2MIF.R for the reportingreportCapitalStock
Read in GDX and extract climate assessment variablesreportClimate
Read in GDX and calculate costs, used in convGDX2MIF.R for the reportingreportCosts
Read in GDX and calculate variables that need variables produced by other report*.R functions, used in convGDX2MIF.R for the reportingreportCrossVariables
Read in GDX and calculate emissions, used in convGDX2MIF.R for the reportingreportEmi
Reports emissions & air pollutant values from GDX for climate assessment in between Nash iterations before some of the energy system variables are defined. The report contains only a subset of reported emissions, with the main difference being that Emi|CA|CO2|Energy and Industrial Processes is calculated from the difference between total and LUC emissions. Only global values from this function should be used, as it also skips the subtraction of certain non-regional sources, such as bunkers, from the regional informationreportEmiForClimateAssessment
Computes the employment values (jobs) across different sectorsreportEmployment
Compute the reporting values of the extraction sectorreportExtraction
Report Extra EmissionsreportExtraEmissions
Read in GDX and calculate final energy, used in convGDX2MIF.R for the reportingreportFE
Report investmentsreportInvestments
Read in GDX and calculate LCOE reporting used in convGDX2MIF_LCOE.reportLCOE
Read in GDX and calculate macro economy values, used in convGDX2MIF.R for the reportingreportMacroEconomy
Calculate and report relevant fossil fuel cost and quantity variables from MOFEX standalone model.reportMOFEX
Read in GDX and calculate primary energy, used in convGDX2MIF.R for the reportingreportPE
Read in GDX and calculate policy costs, used in convGDX2MIF.R for the reportingreportPolicyCosts
Read in GDX and calculate prices, used in convGDX2MIF.R for the reportingreportPrices
Add SDP variables to mif, used in convGDX2MIF.R for the reportingreportSDPVariables
Read in GDX and calculate secondary energy, used in convGDX2MIF.R for the reportingreportSE
Read in GDX and calculate tax, used in convGDX2MIF.R for the reportingreportTax
Read in GDX and calculate technology information, used in convGDX2MIF.R for the reportingreportTechnology
Read in GDX and calculate trade, used in convGDX2MIF.R for the reportingreportTrade
searches all scenario config files of REMIND directory for a switch and prints the occurencesswitchValuesScenConf
Test Ranges on Variables in magpie Objectstest_ranges
time_cumulatetime_cumulate
toolRegionSubsets Returns a list of parent regions that are equal to a child mapping union of region mappings.toolRegionSubsets
Variable Names as Hierarchical ListvariablesAsList