Final review SS on tutorials

e3modelling · Jan 21, 2025 · 145378e · 145378e
1 parent 7ca32d0
commit 145378e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 60 deletions.
diff --git a/tutorials/01_Git and VS Code Settings.md b/tutorials/01_Git and VS Code Settings.md
@@ -1,5 +1,7 @@
 ## Setting Up Git and VS Code for GitHub: A Step-by-Step Guide
 
+This guide is designed for advanced use, though the model can still be utilized without Git or Visual Studio Code.
+
 **Objective:**
 
 By the end of this installation guide, you will be proficient in setting up Git and Visual Studio Code (VS Code) for GitHub collaboration. Through this step-by-step guide, you will learn key terminology, check for and install Git, configure settings, install VS Code, clone a repository, and explore the Task Runner extensions. You will understand how to execute tasks in development and research modes, and utilize VS Code functionalities. 

diff --git a/tutorials/02_Task Runner settings in VS code.md b/tutorials/02_Task Runner settings in VS code.md
@@ -1,10 +1,12 @@
 ## Task Runner Settings in VS code
 
+This guide is designed for advanced use, though the model can still be utilized without Git or Visual Studio Code.
+
 **Objective:**
 
 Learn how to install the Task Runner extension in VS Code. This allows to quickly execute tasks by creating and using buttons similar to the ones found in other programs (e.g. GAMS Studio). These buttons can streamline your workflow, whether for development or research, by automating tasks. You'll also learn about development and research modes, and their computational requirements. 
 
-**Warning:**
+**Warnings:**
 It is recommended to follow this tutorial after completing Tutorial 01 and having cloned the repository, and added all necessary extensions.
 
 ## Step-by-Step Guide

diff --git a/tutorials/00_README.md → tutorials/README.md b/tutorials/00_README.md → tutorials/README.md
@@ -2,7 +2,7 @@
 
 OPEN-PROM ("open PROMETHEUS") is an energy-economy model currently under development. The present version is based on the MENA-EDS ENERGY MODEL v4.0 (c) E3Modelling 2020.
 
-Extensive documentation of the PROMETHEUS model (on which both MENA-EDS and OPEN-PROM are based) can be found here: PROMETHEUS documentation.
+Extensive documentation of the PROMETHEUS model on which both MENA-EDS and OPEN-PROM are based can be found here: https://e3modelling.com/modelling-tools/prometheus/.
 
 OPEN-PROM is written in GAMS (*G*eneral *A*lgebraic *M*odelling *S*ystem https://gams.com/) and its main file is `main.gms`.
 
@@ -31,63 +31,6 @@ For Model Developers:
 Regionalization of OPEN-PROM
 The following section outlines the current regionalization of the OPEN-PROM model.
 
-(Custom native region codes are highlighted - for the rest of the countries their official 3-digit ISO Code will be used).
-Machine-readable mapping is found [here](https://github.com/e3modelling/mrprom/blob/main/inst/extdata/regional/regionmappingOP5.csv)
-
-1.	Austria
-2.	Belgium
-3.	Bulgaria
-4.	Cyprus
-5.	Croatia
-6.	Czech Republic
-7.	Germany
-8.	Denmark
-9.	Spain
-10.	Finland
-11.	France
-12.	United Kingdom
-13.	Greece
-14.	Hungary
-15.	Ireland
-16.	Italy
-17.	Malta
-18.	Netherlands
-19.	Poland
-20.	Portugal
-21.	Slovakia
-22.	Slovenia
-23.	Sweden
-24.	Romania
-25.	USA
-26.	Japan
-27.	Canada
-28.	Brazil
-29.	China /CHINA, MACAO, HONG KONG, TAIWAN/ `**CHA**`
-30.	India
-31.	South Korea
-32.	Indonesia
-33.	Mexico
-34.	Argentina
-35.	Turkey
-36.	Saudi Arabia
-37.	Oceania `**OCE**`
-38.	Russian federation
-39.	Iran
-40.	Nigeria
-41.	Rest of energy producing countries /ALGERIA, AZERBAIJAN, IRAQ, JORDAN, KUWAIT, LEBANON, LIBYAN ARAB JAMAHIRIYA, QATAR, SYRIAN ARAB REPUBLIC, UNITED ARAB EMIRATES, VENEZUELA, WESTERN SAHARA, YEMEN/ `**REP**`                       
-42.	South Africa
-43.	Rest of Europe 1 /NORWAY, SWITZERLAND, ICELAND, LIECHTENSTEIN/ `**NSI**`
-44.	Rest of Europe 2 /ALBANIA, ANDORRA, GREENLAND, VATICAN, SAN MARINO, SVALBARD AND JAN MAYEN, BELARUS, BOSNIA AND HERZEGOVINA, NORTH MACEDONIA, MOLDOVA, REPUBLIC OF MONACO, MONTENEGRO, SERBIA, UKRAINE/ `**REU**`        
-45.	Egypt
-46.	Morocco
-47.	Tunisia
-48.	Israel
-49.	Rest of Latin America `**RLA**`
-50.	Rest of Africa `**RAF**`
-51.	Rest of Asia `**RAS**`
-52.	Rest of world `**RWO**`
-53.	Rest of EU27 /ESTONIA, LUXEMBOURG, LITHUANIA, LATVIA/ `**ELL**`
-
 ***Overview of the tutorials***
 
 A quick overview of the Tutorials contents:
@@ -123,4 +66,7 @@ Examples of GAMS errors, with a URL redirecting you to the official GAMS error c
 Simple steps to troubleshoot and resolve common issues during the setup of Git and Visual Studio Code for GitHub.
 
 - ***09_Creating FIXME Issues from Code Comments:***
-A brief guide to automatically creating new GitHub issues by adding specially formatted comments in your code.
+A brief guide to automatically creating new GitHub issues by adding specially formatted comments in your code.
+
+- ***10_Modular OPEN-PROM guide:***
+A guide to run the model in its modular version by sector.