diff --git a/README.md b/README.md index b06be81..bae75ef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,80 @@ -# JRC-EU-TIMES +## Title: JRC-EU-TIMES model Setup and Scenario Run +## Contact: Evangelos Panos evangelos.panos@psi.ch +============================================== +# Minimum requirements to solve the model +============================================== +- A valid GAMS/CPLEX License +- 64 GB RAM +- CPU threads >10 +- HDD space 10 GB +- Basic Knowledge of the TIMES modelling Framework (see also https://iea-etsap.org/index.php/documentation) + +============================================== +# Installation +============================================== +Download all two directories into the same folder at a local computer. The structure the three directories is as follows: +- Gams_WrkJRCTIMES : contains the model input data +- Results : contains the model result generation routines and template files + +============================================== +# Contents of the model source code directory +============================================== +Please consult the TIMES documentation, available online: https://iea-etsap.org/index.php/documentation + +============================================== +# Contents of the model input data directory +============================================== +The model code and input data are in flat text files with the extension .dmp . +The folder also contains additional files like solver options and the scripts to run the POLIZERO scenarios. In addition, the post-model solution files, with the results of each scenario in raw output format, are also located in this folder. All the above are explained in the subsections below + +## Model input data files +-------------------------------------------- + +BAU.dmp : JRC-EU-TIMES input data and code for the BAU scenario of POLIZERO +CLI.dmp : JRC-EU-TIMES input data and code for the CLI scenario of POLIZERO +CLI90.dmp : JRC-EU-TIMES input data and code for the CLI90 scenario of POLIZERO + +## Other files required for solving the model +-------------------------------------------- +Besides the data input and model code files, there are also additional files controlling the solution of the model. + +cplex.opt : CPLEX solver option files +BAU.CMD : script to run the BAU scenario of POLIZERO +CLI.CMD : script to run the CLI scenario of POLIZERO +CLI90.CMD : script to run the CLI90 scenario of POLIZERO + +## Post-solution files +-------------------------------------------- +When the solution of a scenario with the JRC-EU-TIMES finishes, the corresponding GDX file is generated at the subfolder GAMSSAVE. +There are three GDX files alreaydy there: +BAU.gdx : BAU scenario GDX file +CLI.gdx : CLI scenario GDX file +CLI90.gdx : CLI90 scenario GDX file + +These GDX files are translated into flat text files with extensions .vds, .vde and .vd. These files contain the output of the model in a format suitable for the TIMES licensed user interface VEDA (please see https://iea-etsap.org/index.php/documentation) + +============================================== +# Contents of the model results directory +============================================== + +The subfolder Results contain the following files: + +collect_results_single_scenario.gms : is a routine to process the .vd files of TIMES to a format suitable for EXCEL +Fuel_Prices_JRC.gms : provides a proxy calculation of levelised costs of different energy carriers +Fuel_Prices_JRC_primary_commodity.gms : auxiliary file for the Fuel_Prices_JRC.gms +results_template.xlsb : results template file in EXCEL format for the EU-27 member states, CH, NO and UK +bau.xlsb : results from the BAU scenario of POLIZERO in EXCEL +cli.xlsb : results from the CLI scenario of POLIZERO in EXCEL +cli90.xlsb : results from the CLI90 scenario of POLIZERO in EXCEL + +The subfolder also contains the scripts to produce the results from a TIMES run: +collect_all_scenarios.bat : batch main script to generate the EXCEL files with the results from BAU, CLI and CLI90 +collect_single.bat : auxiliary file to the main file of the script generating the results + +============================================== +# Example of the workflow with the JRC-EU-TIMES +============================================== + +a. execute the scripts BAU.CMD, CLI.CMD and CLI90.CMD to run the BAU, CLI and CLI90 POLIEZRO scenarios +b. execute the script collect_all_scenarios.bat to create the results EXCEL file \ No newline at end of file