Skip to content
Snippets Groups Projects
Commit c2b6a39a authored by Alois Dirnaichner's avatar Alois Dirnaichner
Browse files

Point to tutorials from README file, change tutorials README to markdown.

parent 7de66d7b
No related branches found
No related tags found
1 merge request!118Patch to README and Tutorials
...@@ -13,8 +13,7 @@ The macro-economic core of REMIND is a Ramsey-type optimal growth model ...@@ -13,8 +13,7 @@ The macro-economic core of REMIND is a Ramsey-type optimal growth model
in which intertemporal global welfare is optimized subject to equilibrium constraints. in which intertemporal global welfare is optimized subject to equilibrium constraints.
## DOCUMENTATION ## DOCUMENTATION
The model documentation for version 2.1 can be found at XXX. <!-- The model documentation for version 2.1 can be found at XXX.-->
A most recent version of the documentation can also be extracted from the A most recent version of the documentation can also be extracted from the
model source code via the R package goxygen model source code via the R package goxygen
(https://github.com/pik-piam/goxygen). To extract the documentation, install the (https://github.com/pik-piam/goxygen). To extract the documentation, install the
...@@ -27,6 +26,12 @@ Please pay attention to the REMIND Coding Etiquette when you modify the code ...@@ -27,6 +26,12 @@ Please pay attention to the REMIND Coding Etiquette when you modify the code
The Coding Etiquette is found in the documentation section of the file main.gms. 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. It explains also the used name conventions and other structural characteristics.
## TUTORIALS
Tutorials can be found in the form of markdown files in the repository:
https://github.com/remindmodel/remind/tree/develop/tutorials
## COPYRIGHT ## COPYRIGHT
Copyright 2006-2019 Potsdam Institute for Climate Impact Research (PIK) Copyright 2006-2019 Potsdam Institute for Climate Impact Research (PIK)
......
# | (C) 2006-2019 Potsdam Institute for Climate Impact Research (PIK) ## REMIND Tutorials
# | authors, and contributors see CITATION.cff file. This file is part # How to use .md or .Rmd files in RStudio
# | of REMIND and licensed under AGPL-3.0-or-later. Under Section 7 of
# | AGPL-3.0, you are granted additional permissions described in the
# | REMIND License Exception, version 1.0 (see LICENSE file).
# | Contact: remind@pik-potsdam.de
README: how to use .md or .Rmd files
1. open the file in RStudio (right-click, choose "open with ..." and then RStudio) 1. open the file in RStudio (right-click, choose "open with ..." and then RStudio)
2. for .md files: click "Preview" (upper border of the file window, below "Session" in the Menu Bar). Or press Ctrl+Shift+k 2. for .md files: click "Preview" (upper border of the file window, below "Session" in the Menu Bar). Or press Ctrl+Shift+k
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment