tutorials - implemented reviews

e3modelling · Jan 20, 2025 · 83ad939 · 83ad939
1 parent e9039ba
commit 83ad939
Show file tree

Hide file tree

Showing 14 changed files with 13 additions and 340 deletions.
diff --git a/Tutorials/00_Git and VS Code.md b/Tutorials/00_Git and VS Code.md
diff --git a/...allation Guide and Tutorials/00_README.md → tutorials/00_README.md b/...allation Guide and Tutorials/00_README.md → tutorials/00_README.md
@@ -114,6 +114,7 @@ A brief description of how to execute OPEN-PROM, including the order of script e
 A guide to the countries and regions mapping used in the model and instructions for changing the regionalization. (Work in progress.)
 
 Tutorials for Debugging and Streamlining Workflow:
+
 - ***07_GAMS error codes:***
 Examples of GAMS errors, with a URL redirecting you to the official GAMS error codes documentation.
 

diff --git a/... Tutorials/01_Git and VS Code Settings.md → tutorials/01_Git and VS Code Settings.md b/... Tutorials/01_Git and VS Code Settings.md → tutorials/01_Git and VS Code Settings.md
diff --git a/...als/02_Task Runner settings in VS code.md → ...als/02_Task Runner settings in VS code.md b/...als/02_Task Runner settings in VS code.md → ...als/02_Task Runner settings in VS code.md
diff --git a/...3_Loading Input Data Files with MrPROM.md → ...3_Loading Input Data Files with MrPROM.md b/...3_Loading Input Data Files with MrPROM.md → ...3_Loading Input Data Files with MrPROM.md
@@ -5,8 +5,7 @@ You can move directly to Tutorial named 03_First OPEN-PROM running if you want t
 In this installation guide, you will find a brief guide about loading input data files to the OPEN-PROM model. This is accomplished by utilizing the complementary [`mrprom`](https://github.com/e3modelling/mrprom) R package, that is also developed by E3-Modelling.
 
 ## Installing Necessary Software and Libraries
-Before using the `mrprom` package, you'll need to install a recent version of the R language, available for [download here](https://www.r-project.org/), as well as Rtools (software that allows compilation of R packages from source code), available [here](https://cran.r-project.org/bin/windows/Rtools/). Make sure to install both in folders that do not require admin priviledges! Furthermore, R and Rtools should be added to the PATH variable of your OS, so check the instructions for [Windows](https://www.bbminfo.com/r/r-programming-environment-setup.php) and [Linux](https://www.digitalocean.com/community/tutorials/how-to-view-and-update-the-linux-path-environment-variable), respectively. 
-
+Before using the `mrprom` package, you'll need to install a recent version of the R language, available for [download here](https://www.r-project.org/), as well as Rtools (software that allows compilation of R packages from source code), available [here](https://cran.r-project.org/bin/windows/Rtools/). Make sure to install both in folders that do not require admin priviledges! Furthermore, R and Rtools should be added to the PATH variable of your OS, so check the instructions for [Windows](https://www.bbminfo.com/r/r-programming-environment-setup.php) and [Linux](https://www.digitalocean.com/community/tutorials/how-to-view-and-update-the-linux-path-environment-variable), respectively. Please be sure that the library reticulate is installed in R.
 
 
 After making sure that R is correctly set up on your system, launch the R console and execute the following commands:

diff --git a/...d Tutorials/04_First OPEN‐PROM running.md → tutorials/04_First OPEN‐PROM running.md b/...d Tutorials/04_First OPEN‐PROM running.md → tutorials/04_First OPEN‐PROM running.md
@@ -1,8 +1,8 @@
 # Purpose: learning to Run the OPEN-PROM Model with dummy data
-As it will be mentioned in Tutorial 05, OPEN-PROM utilizes some proprietary data sources that can't be publicly shared. To run the OPEN-PROM model for the first time, you can use dummy data to test its functionality and ensure everything is set up correctly. This allows you to familiarize yourself with the model’s structure, configuration, and output without needing access to proprietary data. The following section will guide you through the steps to create a configuration file, adjust the necessary settings, and execute the model using dummy data. This will provide you with a clear understanding of how the model operates and allow you to begin experimenting with its features.
+ OPEN-PROM utilizes some proprietary data sources that can't be publicly shared. To run the OPEN-PROM model for the first time, you can use dummy data to test its functionality and ensure everything is set up correctly. This allows you to familiarize yourself with the model’s structure, configuration, and output without needing access to proprietary data. The following section will guide you through the steps to create a configuration file, adjust the necessary settings, and execute the model using dummy data. This will provide you with a clear understanding of how the model operates and allow you to begin experimenting with its features.
 
 ## 1st step: download the tag version of the model
- You can start running and experimenting with the model, even if you don't have access to the aforementioned proprietary data. You simply need to download [OPEN-PROM v1.0.0](https://github.com/e3modelling/OPEN-PROM/releases/tag/v1.0.0), and make sure you have recent versions of GAMS and the R language installed on your computer. Please be sure that The library reticulate is installed in R.
+ You can start running and experimenting with the model, even if you don't have access to the aforementioned proprietary data. You simply need to download [OPEN-PROM v1.0.0](https://github.com/e3modelling/OPEN-PROM/releases/tag/v1.0.0), and make sure you have recent versions of GAMS and the R language installed on your computer. Please be sure that the library reticulate is installed in R.
 
 ## 2nd step: Creating a Configuration File
 Customization and flexibility is a priority during the development of OPEN-PROM, so we have included a configuration file that lets users change model settings. To create your own configuration file, please **make a copy** of the `config.template.json` file and rename it to `config.json`. Afterwards, you will be able to configure various settings, such as the custom GAMS system directory.