Skip to content

Commit

Permalink
Added function for loading Balmorel .incfiles
Browse files Browse the repository at this point in the history
  • Loading branch information
@Mathias157
Mathias157 committed Sep 10, 2024
1 parent 7dc0f91 commit fd2d55b
Show file tree
Hide file tree
Showing 4 changed files with 527 additions and 5 deletions.
53 changes: 49 additions & 4 deletions examples/Execution.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@
" if project_root not in sys.path:\n",
" sys.path.insert(0, project_root)\n",
" from src.pybalmorel import Balmorel\n",
" from src.pybalmorel.utils import symbol_to_df\n",
" import pybalmorel # needed for copying GAMS reader files for the .load_incfiles function\n",
"else:\n",
" from pybalmorel import Balmorel"
" from pybalmorel import Balmorel\n",
" from pybalmorel.utils import symbol_to_df"
]
},
{
Expand All @@ -37,7 +40,7 @@
"source": [
"### Balmorel Class\n",
"\n",
"The Balmorel class can be used to recognise scenarios, run scenarios and easily collect results "
"The Balmorel class can be used to recognise scenarios, load .inc files into python or run scenarios and easily collect results "
]
},
{
Expand All @@ -48,8 +51,50 @@
"source": [
"# Initiate Model Class\n",
"model = Balmorel('path/to/model/folder')\n",
"print(model.scenarios) # Print recognised scenarios\n",
"\n",
"print(model) # Print recognised scenarios"
]
},
{
"cell_type": "code",
"execution_count": 13,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
" Y R DEUSER Value_MWh\n",
"0 2016 DK1 RESE 5.315044e+06\n",
"1 2016 DK1 PII 7.533239e+05\n",
"2 2016 DK1 OTHER 1.096689e+07\n",
"3 2016 DK2 RESE 3.647737e+06\n",
"4 2016 DK2 PII 5.170094e+05\n",
"... ... ... ... ...\n",
"6824 2050 MT TRANS_BUS 8.520674e+05\n",
"6825 2050 CY RESE 8.185034e+05\n",
"6826 2050 CY PII 1.378676e+06\n",
"6827 2050 CY OTHER 1.402362e+06\n",
"6828 2050 CY TRANS_BUS 2.503435e+06\n",
"\n",
"[6829 rows x 4 columns]\n"
]
}
],
"source": [
"# Load .inc-files to Python\n",
"# This function executes Balmorel up until the model is reduced and run, i.e. only reading inc-files \n",
"# Note that if your version differs from master branch, commit id 18e21979, you may need to create your own read_files\n",
"# The read_files were created using the Balmorel.gms and Balmorelbb4.inc-files, deleting everything that reduces dataset or runs the model\n",
"model.load_incfiles('base')\n",
"print(symbol_to_df(model.input_data['base'], 'DE', ['Y', 'R', 'DEUSER', 'Value_MWh']))\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# Run Model\n",
"model.run('base', {'some_cmd_line_option' : 'arg'})\n",
"\n",
Expand Down
119 changes: 119 additions & 0 deletions src/pybalmorel/Balmorel_ReadData.gms
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
* File Balmorel.gms
$TITLE Balmorel version 4.03 (March 2022; latest 20220318)

SCALAR IBALVERSN 'This version of Balmorel' /403.20220318/;
* Efforts have been made to make a good model.
* However, most probably the model is incomplete and subject to errors.
* It is distributed with the idea that it will be usefull anyway,
* and with the purpose of getting the essential feedback,
* which in turn will permit the development of improved versions
* to the benefit of other user.
* Hopefully it will be applied in that spirit.

* All GAMS code of the Balmorel model is distributed under ICS license,
* see the license file in the base/model folder.


*-------------------------------------------------------------------------------
*-------------------------------------------------------------------------------
*-------------------------------------------------------------------------------


* This is a preliminary version of Balmorel 3.03.
* It is intended for review and commenting.
* See a short list of changes since previous version 3.02 in base/documentation/Balmorel303.txt.
* It is scheduled that a final version 3.03 will be available early 2017.

*-------------------------------------------------------------------------------
*-------------------------------------------------------------------------------
*-------------------------------------------------------------------------------


* GAMS options are $included from file balgams.opt.
* In order to make them apply globally, the option $ONGLOBAL will first be set here:
$ONGLOBAL

$ifi %system.filesys%==UNIX
execute 'chmod -R ug+rw "../.."';

* The balgams file holds control settings for GAMS.
* Use local file if it exists, otherwise use the one in folder ../../base/model/.
$ifi exist 'balgams.opt' $include 'balgams.opt';
$ifi not exist 'balgams.opt' $include '../../base/model/balgams.opt';

* The balopt file holds option (control) settings for the Balmorel model.
* Use local file if it exists, otherwise use the one in folder ../../base/model/.


$ifi exist 'balopt.opt' $include 'balopt.opt';
$ifi not exist 'balopt.opt' $include '../../base/model/balopt.opt';

$ifi %system.filesys%==UNIX
execute 'chmod -R ug+rw "../.."';

* If merging of savepoint files is to be performed,
* make sure that there are no gdx files initially in applied folders:
$ifi %system.filesys%==UNIX
$ifi %MERGESAVEPOINTRESULTS%==yes execute "rm *.gdx";
$ifi %system.filesys%==MSNT
$ifi %MERGESAVEPOINTRESULTS%==yes execute "del *.gdx";
$ifi %system.filesys%==UNIX
$ifi %MERGESAVEPOINTRESULTS%==yes execute "rm ../output/temp/*.gdx";
$ifi %system.filesys%==MSNT
$ifi %MERGESAVEPOINTRESULTS%==yes execute "del ..\output\temp\*.gdx";

*-------------------------------------------------------------------------------
*-------------------------------------------------------------------------------
*---- Some generally applicable stuff: -----------------------------------------
*-------------------------------------------------------------------------------


* The following may be used in display, put or execute_unload statements (the text, not the value, holds relevant information)
SCALAR SystemDateTime "%system.date%, %system.time%" /NA/;

* Displaying only a text string will not be accessible through the 'table of content' on the .lst file, therefore this
SCALAR INFODISPLAY "See information next:" /NA/;
DISPLAY INFODISPLAY, "Balmorel run stared at", SystemDateTime;

* Convenient Factors, typically relating Output and Input:
SCALAR IOF100 'Multiplier 100' /100/;
SCALAR IOF1000 'Multiplier 1000' /1000/;
SCALAR IOF1000000 'Multiplier 1000000' /1000000/;
SCALAR IOF0001 'Multiplier 0.001' /0.001/;
SCALAR IOF0000001 'Multiplier 0.000001' /0.000001/;
SCALAR IOF3P6 'Multiplier 3.6' /3.6/;
SCALAR IOF24 'Multiplier 24' /24/;
SCALAR IOF8760 'Multiplier 8760' /8760/;
SCALAR IOF8784 'Multiplier 8784' /8784/;
SCALAR IOF365 'Multiplier 365' /365/;
SCALAR IOF05 'Multiplier 0.5' /0.5/;
SCALAR IOF1_ 'Multiplier 1 (used with QOBJ and derivation of marginal values)' /1/;!! special, possibly to disappear in future versions
* Scalars for occational use, their meaning will be context dependent:
SCALAR ISCALAR1 '(Context dependent)';
SCALAR ISCALAR2 '(Context dependent)';
SCALAR ISCALAR3 '(Context dependent)';
SCALAR ISCALAR4 '(Context dependent)';
SCALAR ISCALAR5 '(Context dependent)';

* Initialisations of printing of log and error files and messages:
$INCLUDE '../../base/logerror/logerinc/error1.inc';

* Ensuring existence of needed output folders:
$ifi not dexist "../../simex" execute 'mkdir -p "../../simex"';
$ifi not dexist "../logerror/logerinc" execute 'mkdir -p "../logerror/logerinc"';
$ifi not dexist "../output/economic" execute 'mkdir -p "../output/economic"';
$ifi not dexist "../output/inputout" execute 'mkdir -p "../output/inputout"';
$ifi not dexist "../output/printout" execute 'mkdir -p "../output/printout"';
$ifi not dexist "../output/temp" execute 'mkdir -p "../output/temp"';


*-------------------------------------------------------------------------------
*---- End: Some generally applicable stuff -------------------------------------
*-------------------------------------------------------------------------------

*-------------------------------------------------------------------------------
*-------------------------------------------------------------------------------
* In case of Model Balbase4 the following included file substitutes the remaining part of the present file Balmorel.gms:
* Use local file if it exists, otherwise use the one in folder ../../base/model/.
$ifi %BB4%==yes $ifi exist 'Balmorelbb4_ReadData.inc' $include 'Balmorelbb4_ReadData.inc';
$ifi %BB4%==yes $ifi not exist 'Balmorelbb4_ReadData.inc' $include '../../base/model/Balmorelbb4_ReadData.inc';
Loading

0 comments on commit fd2d55b

Please sign in to comment.