Merge pull request #73 from johanneskoch94/documentation_changes

Reintroduce line breaks in main.gms documentation

main.gms

@@ -7,17 +7,49 @@
 *** SOF ./main.gms
 *' @title REMIND - REgional Model of INvestments and Development
 *'
-*' @description REMIND is a global multi-regional model incorporating the economy, the climate system and a detailed representation of the energy sector. It solves for an intertemporal Pareto optimum in economic and energy investments in the model regions, fully accounting for interregional trade in goods, energy carriers and emissions allowances. REMIND enables analyses of technology options and policy proposals for climate change mitigation.
+*' @description REMIND is a global multi-regional model incorporating the economy, the climate system 
+*' and a detailed representation of the energy sector. It solves for an intertemporal Pareto optimum 
+*' in economic and energy investments in the model regions, fully accounting for interregional trade in 
+*' goods, energy carriers and emissions allowances. REMIND enables analyses of technology options and 
+*' policy proposals for climate change 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 ([02_welfare]). Intertemporal optimization ([80_optimization]) with perfect foresight is subject to market clearing. The model explicitly represents trade in final goods, primary energy carriers, and when certain climate policies are enabled, emissions allowances ([24_trade]). The macro-economic production factors are capital, labor, and final energy. A nested production function with constant elasticity of substitution determines the final energy demand ([01_macro], [29_CES_parameters]). REMIND uses economic output for investments in the macro-economic capital stock as well as for consumption, trade, and energy system expenditures. 
+*' The macro-economic core of REMIND is a Ramsey-type optimal growth model in which intertemporal global 
+*' welfare is optimized subject to equilibrium constraints ([02_welfare]). Intertemporal optimization 
+*' ([80_optimization]) with perfect foresight is subject to market clearing. The model explicitly represents 
+*' trade in final goods, primary energy carriers, and when certain climate policies are enabled, emissions 
+*' allowances ([24_trade]). The macro-economic production factors are capital, labor, and final energy. 
+*' A nested production function with constant elasticity of substitution determines the final energy demand 
+*' ([01_macro], [29_CES_parameters]). REMIND uses economic output for investments in the macro-economic 
+*' capital stock as well as for consumption, trade, and energy system expenditures. 
 *' 
-*' The macro-economic core and the energy system part are hard-linked via the final energy demand and the costs incurred by the energy system. Economic activity results in demand for final energy in different sectors (transport ([35_transport]), industry ([37_industry]), buildings ([36_buildings])...) and of different type (electric ([32_power]) and non-electric). The primary energy carriers in REMIND include both exhaustible and renewable resources. Exhaustible resources comprise uranium as well as three fossil resources ([31_fossil]), namely coal, oil, and gas. Renewable resources include hydro, wind, solar, geothermal, and biomass ([30_biomass]). More than 50 technologies are available for the conversion of primary energy into secondary energy carriers as well as for the distribution of secondary energy carriers into final energy.
+*' The macro-economic core and the energy system part are hard-linked via the final energy demand and the 
+*' costs incurred by the energy system. Economic activity results in demand for final energy in different 
+*' sectors (transport ([35_transport]), industry ([37_industry]), buildings ([36_buildings])...) and of 
+*' different type (electric ([32_power]) and non-electric). The primary energy carriers in REMIND include 
+*' both exhaustible and renewable resources. Exhaustible resources comprise uranium as well as three fossil 
+*' resources ([31_fossil]), namely coal, oil, and gas. Renewable resources include hydro, wind, solar, 
+*' geothermal, and biomass ([30_biomass]). More than 50 technologies are available for the conversion of 
+*' primary energy into secondary energy carriers as well as for the distribution of secondary energy carriers 
+*' into final energy.
 *'
-*' The model accounts for the full range of anthropogenic greenhouse gas (GHG) emissions, most of which are represented by source. REMIND simulates emissions from long-lived GHGs (CO2, CH4, N2O), short-lived GHGs (CO, NOx, VOC) and aerosols (SO2, BC, OC). It accounts for these emissions with different levels of detail depending on the types and sources of emissions. It calculates CO2 emissions from fuel combustion, CH4 emissions from fossil fuel extraction and residential energy use, and N2O emissions from energy supply based on sources. 
+*' The model accounts for the full range of anthropogenic greenhouse gas (GHG) emissions, most of which are 
+*' represented by source. REMIND simulates emissions from long-lived GHGs (CO2, CH4, N2O), short-lived GHGs 
+*' (CO, NOx, VOC) and aerosols (SO2, BC, OC). It accounts for these emissions with different levels of detail 
+*' depending on the types and sources of emissions. It calculates CO2 emissions from fuel combustion, CH4 
+*' emissions from fossil fuel extraction and residential energy use, and N2O emissions from energy supply 
+*' based on sources. 
 *'
-*' The code is structured in a modular way, with code belonging either to the model's core, or to one of the modules. The folder structure is as follows: at the top level are the folders config, core, modules and scripts. The config folder contains the REMIND settings and configuration information. The core folder contains all the files that are part of the core. The modules folder holds all the files that belong to the modules, with numbered sub-folders for every module. The scripts folder contains helpful scripts for starting a model run and analysing results.
+*' The code is structured in a modular way, with code belonging either to the model's core, or to one of the 
+*' modules. The folder structure is as follows: at the top level are the folders config, core, modules and 
+*' scripts. The config folder contains the REMIND settings and configuration information. The core folder 
+*' contains all the files that are part of the core. The modules folder holds all the files that belong to 
+*' the modules, with numbered sub-folders for every module. The scripts folder contains helpful scripts for 
+*' starting a model run and analysing results.
 *' 
-*' REMIND is run by executing the main.gms file, which loads the configuration information and builds the model, by concatenating all necessary files from the core and modules folders into a single file called full.gms. The concatenation process starts with files from the core and continues with files from activated modules, in increasing order of module-number. It observes the following structure:
+*' REMIND is run by executing the main.gms file, which loads the configuration information and builds the model, 
+*' by concatenating all necessary files from the core and modules folders into a single file called full.gms. 
+*' The concatenation process starts with files from the core and continues with files from activated modules, 
+*' in increasing order of module-number. It observes the following structure:
 *'
 *' ![Technical Structure of REMIND](technical_structure.png){ width=100% }
 *'
@@ -30,14 +62,17 @@
 *' * "f_" to designate file parameters (parameters that contain unaltered data read in from input files),
 *' * "o_" to designate output parameters (parameters that do not affect the optimization, but are affected by it),
 *' * "c_" to designate switches (parameters that enable different configuration choices),
-*' * "s_FIRSTUNIT_2_SECONDUNIT" to designate a scalar used to convert from the FIRSTUNIT to the SECONDUNIT through multiplication, e.g. s_GWh_2_EJ.
+*' * "s_FIRSTUNIT_2_SECONDUNIT" to designate a scalar used to convert from the FIRSTUNIT to the SECONDUNIT 
+*'                              through multiplication, e.g. s_GWh_2_EJ.
 *'
 *' These prefixes are extended in some cases by a second letter:
 *'
 *' * "?m_" to designate objects used in the core and in at least one module.
-*' * "?00_" to designate objects used in a single module, exclusively, with the 2-digit number corresponding to the module number.
+*' * "?00_" to designate objects used in a single module, exclusively, with the 2-digit number corresponding 
+*'          to the module number.
 *'
-*' Sets are treated differently: instead of a prefix, sets exclusively used within a module get that module's number added as a suffix. If the set is used in more than one module no suffix is given. 
+*' Sets are treated differently: instead of a prefix, sets exclusively used within a module get that module's 
+*' number added as a suffix. If the set is used in more than one module no suffix is given. 
 *' 
 *' The units (e.g., TWa, EJ, GtC, GtCO2, ...) of variables and parameters are documented in the declaration files.