The REgional Model of INvestments and Development

A modular open source multi-regional model incorporating the economy, the climate system and a detailed representation of the energy sector.
https://github.com/remindmodel/remind

Category: Sustainable Development
Sub Category: Sustainable Investment

Keywords from Contributors

land gams pik magpie energy-system energy-system-model climate-change climate-model simulator cryptocurrency

Last synced: about 2 hours ago
JSON representation

Repository metadata

REMIND - REgional Model of INvestments and Development

README.md

REMIND - REgional Model of INvestments and Development

CodeCheck Status

https://www.pik-potsdam.de/research/transformation-pathways/models/remind

WHAT IS REMIND?

The REgional Model of INvestments and Development (REMIND)
is a modular open source multi-regional model incorporating the economy,
the climate system and a detailed representation of the energy sector.
It solves for an inter-temporal Pareto optimum in economic and energy investments in the model regions,
fully accounting for interregional trade in goods, energy carriers and emissions allowances.
REMIND allows for the analysis of technology options and policy proposals for climate mitigation.
The macro-economic core of REMIND is a Ramsey-type optimal growth model
in which intertemporal global welfare is optimized subject to equilibrium constraints.

DOCUMENTATION

A model description paper on REMIND 2.1 has been published in Geoscientific Model Development (GMD): https://doi.org/10.5194/gmd-14-6571-2021 .

The model documentation for version 3.2.0 can be found at https://rse.pik-potsdam.de/doc/remind/3.2.0 .

The most recent version of the documentation can also be extracted from the
model source code via the R package goxygen
(https://github.com/pik-piam/goxygen). To extract the documentation, run make docs
in the main folder of the model.
The resulting documentation can be found in the folder doc/.

Please pay attention to the REMIND Coding Etiquette when you modify the code
(if you plan on contributing to the REMIND official repository).
The Coding Etiquette is found in the documentation section of the file main.gms.
It explains also the used name conventions and other structural characteristics.
To automatically check if some aspects of the coding etiquette, you can run
make check in the main folder of the model.

TUTORIALS

Tutorials can be found in the form of markdown files in the repository:

https://github.com/remindmodel/remind/tree/develop/tutorials

COPYRIGHT

Copyright 2006-2024 Potsdam Institute for Climate Impact Research (PIK)

LICENSE

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, version 3 of the License or later. You should
have received a copy of the GNU Affero General Public License along with this
program. See the LICENSE file in the root directory. If not, see
https://www.gnu.org/licenses/agpl.txt

Under Section 7 of AGPL-3.0, you are granted additional permissions described
in the REMIND License Exception, version 1.0 (see LICENSE file).

NOTES

Following the principles of good scientific practice it is recommended
to make the source code available in the events of model based publications
or model-based consulting.

When using a modified version of REMIND which is not identical to versions
in the official main repository at https://github.com/remindmodel add a suffix
to the name to allow distinguishing versions (format REMIND-suffix).

SYSTEM REQUIREMENTS

The full model is quite resource heavy and works best on machines with high CPU clock
and memory. Recommended is a machine with Windows, MacOS or Linux, with at least
16GB of memory and a Core i7 CPU or similar.

HOW TO INSTALL

Please refer to the installation guide.

HOW TO CONFIGURE

Model run settings are set in config/default.cfg and main.gms (or another config file of
the same structure). New model scenarios can be created by adding a row to
config/scenario_config.csv

HOW TO RUN

Please refer to the tutorials on how to
use the default settings and how to
run multiple scenarios.

HOW TO CONTRIBUTE

We are interested in working with you! Contact us through GitHub
(https://github.com/remindmodel) or by E-mail (remind@pik-potsdam.de) if you have
found and/or fixed a bug, developed a new model feature, have ideas for further
model development or suggestions for improvements. We are open to
any kind of contribution. Our aim is to develop an open, transparent and
meaningful energy-economy-model, and to get a better
understanding of the underlying processes and possible futures. Join us in doing
so!

DEPENDENCIES

Model dependencies must be publicly available and should be Open Source.
Development aim is to rather minimize than expand dependencies on non-free
and/or non open source software. That means that besides currently existing
dependencies on GAMS, the gdxrrw R package and the corresponding solvers there
should be no additional dependencies of this kind and that these existing
dependencies should be resolved in the future if possible.

If a new R package is added as dependency this package should fulfill the
following requirements:

  • The package is published under an Open Source license
  • The package is distributed through CRAN or PIK-CRAN (the PIK-based,
    but publicly available package repository).
  • The package source code is available through a public, version controlled
    repository such as GitHub

For other dependencies comparable measures should apply. When a dependency is
added this dependency should be added to the HOW TO INSTALL section in the
README file of the model (mentioning the depencendy and explaining
how it can be installed). If not all requirements can be fulfilled by the new
dependency this case should be discussed with the model maintainer
(remind@pik-potsdam.de) to find a good solution for it.

INPUT DATA

In order to allow other researchers to reproduce and use work done with REMIND
one needs to make sure that all components necessary to perform a run can be
shared. One of these components is the input data. As proprietary data usually
does not allow its free distribution it should generally be avoided.

When adding a new data source, make sure that it can be freely shared with
others. If this is not the case please consider using a different source or
solution.

Data preparation should ideally be performed with the madrat data processing
framework (https://github.com/pik-piam/madrat). This makes sure that the
processing is reproducible and links properly to the already existing data
processing for REMIND.

In case that these recommendations can not be followed we would be happy if you
could discuss that issue with the REMIND development team
(remind@pik-potsdam.de).

MODEL OUTPUT

By default the results for a model run are written to an individual results folder within the "output/" folder of the model. The two most important output files are the fulldata.gdx and the REMIND_generic_scenario-name.mif. The fulldata.gdx is the technical output of the GAMS optimization and contains all quantities that were used during the optimization in unchanged form. The mif-file is a csv file of certain format and is synthetized from the fulldata.gdx by post-processing scripts. It can be read in any text editor or spreadsheet program and is well suited for a quick look at the results and for further analysis.

CONTACT

remind@pik-potsdam.de

KNOWN BUGS

TROUBLESHOOTING

Please contact remind@pik-potsdam.de

CITATION

See file CITATION.cff or the documentation of the model for information how
to cite the model.

DOI

AUTHORS

See list of authors in CITATION.cff

CHANGELOG

See CHANGELOG.md on GitHub.

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this model, please cite it as below.
type: software
authors:

- family-names: "Luderer"
  given-names:  "Gunnar"
  orcid: https://orcid.org/0000-0002-9057-6155
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Bauer"
  given-names:  "Nico"
  orcid: https://orcid.org/0000-0002-0211-4162
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Baumstark"
  given-names:  "Lavinia"
  orcid: https://orcid.org/0000-0002-6979-6671
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Bertram"
  given-names:  "Christoph"
  orcid: https://orcid.org/0000-0002-0933-4395
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Leimbach"
  given-names:  "Marian"
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Pietzcker"
  given-names:  "Robert"
  orcid: https://orcid.org/0000-0002-9403-6711
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Strefler"
  given-names:  "Jessica"
  orcid: https://orcid.org/0000-0002-5279-4629
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Aboumahboub"
  given-names:  "Tino"

- family-names: "Abrahão"
  given-names:  "Gabriel"
  orcid: https://orcid.org/0000-0003-0336-6246
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Auer"
  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"

- family-names: "Bi"
  given-names:  "Stephen"
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Dietrich"
  given-names:  "Jan Philipp"
  orcid: https://orcid.org/0000-0002-4309-6431
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Dirnaichner"
  given-names:  "Alois"
  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
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Fuchs"
  given-names:  "Sophie"
  orcid: https://orcid.org/0009-0000-7258-1287
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Führlich"
  given-names:  "Pascal"
  orcid: https://orcid.org/0000-0002-6856-8239
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Giannousakis"
  given-names:  "Anastasis"
  orcid: https://orcid.org/0000-0002-4225-0011
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Gong"
  given-names:  "Chen Chris"
  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"

- family-names: "Hasse"
  given-names:  "Robin"
  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"
  given-names:  "David"
  orcid: https://orcid.org/0009-0001-7917-8041
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Koch"
  given-names:  "Johannes"
  orcid: https://orcid.org/0000-0003-2920-8086
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Köhler-Schindler"
  given-names:  "Laurin"
  orcid: https://orcid.org/0000-0003-4268-3084
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Körner"
  given-names:  "Alexander"

- family-names: "Kowalczyk"
  given-names:  "Katarzyna"
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Kriegler"
  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"

- family-names: "Lorenz"
  given-names:  "Alexander"

- family-names: "Ludig"
  given-names:  "Sylvie"

- family-names: "Lüken"
  given-names:  "Michael"

- family-names: "Malik"
  given-names:  "Aman"
  orcid: https://orcid.org/0000-0002-7310-8448
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Mandaroux"
  given-names:  "Rahel"
  orcid: https://orcid.org/0000-0001-5596-2571
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Manger"
  given-names:  "Susanne"

- family-names: "Merfort"
  given-names:  "Anne"
  orcid: https://orcid.org/0000-0002-5929-7748
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Merfort"
  given-names:  "Leon"
  orcid: https://orcid.org/0000-0003-1704-6892
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Moreno-Leiva"
  given-names:  "Simón"
  orcid: https://orcid.org/0000-0002-9625-3955
  affiliation: "Potsdam Institute for Climate Impact Research"

- 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
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Pehl"
  given-names:  "Michaja"
  orcid: https://orcid.org/0000-0003-2349-6515
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Pflüger"
  given-names:  "Mika"
  orcid: https://orcid.org/0000-0002-7814-8916
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Piontek"
  given-names:  "Franziska"
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Popin"
  given-names:  "Laura"

- family-names: "Rauner"
  given-names:  "Sebastian"
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Richters"
  given-names:  "Oliver"
  orcid: https://orcid.org/0000-0001-8253-4716
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Rodrigues"
  given-names:  "Renato"
  orcid: https://orcid.org/0000-0002-5863-5514
  affiliation: "Potsdam Institute for Climate Impact Research"

- 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"

- family-names: "Rüter"
  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"

- family-names: "Schötz"
  given-names:  "Christof"
  orcid: https://orcid.org/0000-0003-3528-4544
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Schreyer"
  given-names:  "Felix"
  orcid: https://orcid.org/0000-0003-0376-2599
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Schultes"
  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
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Ueckerdt"
  given-names:  "Falko"
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Verpoort"
  given-names:  "Philipp"
  orcid: https://orcid.org/0000-0003-1319-5006
  affiliation: "Potsdam Institute for Climate Impact Research"

- family-names: "Weigmann"
  given-names:  "Pascal"
  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
  with a special focus on the development of the energy sector and the implications
  for our world climate. The goal of REMIND is to find the optimal mix of investments
  in the economy and the energy sectors of each model region given a set of population,
  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.5.0.dev64"
date-released: 2025-04-16
repository-code: https://github.com/remindmodel/remind
keywords:
  - energy
  - economy
  - modeling
  - model
  - active-development
license: AGPL-3.0-or-later
url: https://www.pik-potsdam.de/research/transformation-pathways/models/remind

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 6,448
Total Committers: 74
Avg Commits per committer: 87.135
Development Distribution Score (DDS): 0.893

Commits in past year: 1,664
Committers in past year: 39
Avg Commits per committer in past year: 42.667
Development Distribution Score (DDS) in past year: 0.772

Name Email Commits
Renato-Rodrigues r****s@p****e 687
Felix Schreyer s****r@p****e 602
REMIND Research Software Engineering r****e@p****e 601
orichters o****r@p****e 586
Lavinia Baumstark b****k@p****e 513
David Klein d****n@p****e 350
Michaja Pehl p****l@p****e 286
Marianna Rottoli m****i@m****t 241
Chen Gong c****g@g****m 240
Mika Pflüger m****r@p****e 173
robertpietzcker p****r@p****e 154
Pascal Führlich p****h@p****e 119
Alois Dirnaichner a****i@d****m 106
Tonn Rüter t****u@p****e 106
Jakob Duerrwaechter j****r@p****e 101
Laurin Köhler-Schindler l****r@p****e 100
gabriel-abrahao g****o@g****m 100
lecfab l****t@g****m 94
Falk Benke f****e@p****e 87
Antoine Levesque l****e@p****e 86
giannou 1****u 82
Christof Schoetz c****z@p****e 79
Leon Merfort 5****t 75
Pascal Weigmann p****n@p****e 70
tabeado t****f@p****e 70
Katarzyna Kowalczyk k****w@p****e 45
amerfort a****t@p****e 45
Tonn Rüter t****r@p****e 42
Bjoern Soergel 1****8 39
Simon Moreno S****o@p****e 39
and 44 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 187
Total pull requests: 1,998
Average time to close issues: 5 months
Average time to close pull requests: 10 days
Total issue authors: 26
Total pull request authors: 65
Average comments per issue: 2.97
Average comments per pull request: 1.0
Merged pull request: 1,825
Bot issues: 0
Bot pull requests: 7

Past year issues: 7
Past year pull requests: 490
Past year average time to close issues: 3 months
Past year average time to close pull requests: 5 days
Past year issue authors: 3
Past year pull request authors: 40
Past year average comments per issue: 2.29
Past year average comments per pull request: 1.1
Past year merged pull request: 430
Past year bot issues: 0
Past year bot pull requests: 1

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/remindmodel/remind

Top Issue Authors

  • 0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q (75)
  • giannou (34)
  • orichters (24)
  • Renato-Rodrigues (9)
  • johanneskoch94 (6)
  • robertpietzcker (6)
  • Loisel (4)
  • mikapfl (4)
  • rauner (3)
  • chroetz (3)
  • pweigmann (2)
  • amnmalik (2)
  • merfort (2)
  • dbantje (1)
  • piklev (1)

Top Pull Request Authors

  • orichters (357)
  • LaviniaBaumstark (234)
  • 0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q (205)
  • dklein-pik (116)
  • fschreyer (99)
  • Renato-Rodrigues (99)
  • MariannaR (62)
  • Loisel (59)
  • laurinks (52)
  • giannou (51)
  • cchrisgong (50)
  • robertpietzcker (45)
  • fbenke-pik (39)
  • mikapfl (34)
  • johanneskoch94 (34)

Top Issue Labels

  • bug (83)
  • question (24)
  • enhancement (20)
  • code cleaning (14)
  • minor (9)
  • documentation (9)
  • invalid (4)
  • help wanted (3)
  • good first issue (2)
  • calibration (1)
  • short-term (1)

Top Pull Request Labels

  • enhancement (22)
  • bug (18)
  • documentation (12)
  • Chemicals (7)
  • code cleaning (6)
  • minor (4)
  • question (3)

Dependencies

.github/workflows/test-code.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 4.0.0 depends
  • GDPuc * imports
  • R.utils * imports
  • SPEI * imports
  • callr * imports
  • colorspace * imports
  • crayon * imports
  • data.table * imports
  • devtools * imports
  • dplyr * imports
  • edgeTransport * imports
  • flexdashboard * imports
  • gdx * imports
  • gdxdt * imports
  • gdxrrw * imports
  • ggplot2 * imports
  • gms >= 0.21.0 imports
  • goxygen * imports
  • gridExtra * imports
  • gtools * imports
  • hdf5r * imports
  • here * imports
  • htmltools * imports
  • iamc * imports
  • kableExtra * imports
  • knitr * imports
  • lazyeval * imports
  • lpjclass * imports
  • lucode2 >= 0.36.0 imports
  • luplot * imports
  • luscale * imports
  • lusweave * imports
  • magclass * imports
  • magpie4 * imports
  • magpiesets * imports
  • mip * imports
  • modelstats * imports
  • mrremind * imports
  • mrvalidation * imports
  • ncdf4 * imports
  • nleqslv * imports
  • optparse * imports
  • piamInterfaces >= 0.0.37 imports
  • piamenv >= 0.4.0 imports
  • plotly * imports
  • purrr * imports
  • quitte >= 0.3106.0 imports
  • raster * imports
  • readr * imports
  • readxl * imports
  • remind2 >= 1.104.1 imports
  • renv * imports
  • reshape2 * imports
  • reticulate * imports
  • rlang * imports
  • rmarkdown * imports
  • rmndt * imports
  • stringr * imports
  • terra * imports
  • tibble * imports
  • tidyr * imports
  • tidyverse * imports
  • withr * imports
  • writexl * imports
  • yaml * imports
  • zoo * imports
.github/workflows/auto-dev-version.yaml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v3 composite
  • gittools/actions/gitversion/execute v0.9.15 composite
  • gittools/actions/gitversion/setup v0.9.15 composite
requirements.txt pypi

Score: 9.314700387300427