updates to the Docs

DispaSET/solve.py

@@ -20,7 +20,14 @@
 from .misc.gdx_handler import get_gams_path, import_local_lib, package_exists
 
 def is_sim_folder_ok(sim_folder):
-
+    '''
+    Function that checks if the provided path is a valid Dispa-SET simulation folder
+    The following files are required:
+        - Inputs.gdx
+        - UCM_h.gms
+        
+    :param sim_folder: path (absolute or relative) to the simulation folder
+    '''
     if not os.path.exists(sim_folder):
         logging.error('The provided DispaSET simulation environment folder (' + sim_folder + ') does not exist')
         return False
@@ -36,6 +43,15 @@ def is_sim_folder_ok(sim_folder):
 
 
 def solve_GAMS(sim_folder, gams_folder=None, work_dir=None, output_lst=False):
+    '''
+    Function used to run the optimization using the GAMS engine. 
+    
+    :param sim_folcer: path to a valid Dispa-SET simulation folder
+    :param gams_folder: path to the gams folder. If not provided, the script will try to find it automatically
+    :param work_dir: path to the working directory (does not need to be provided)
+    :param output_lst: Set to True to conserve a copy of the GAMS lst file in the simulation folder
+    '''
+
     if not package_exists('gams'):
         logging.warning('Could not import gams. Trying to automatically locate gdxcc folder')
         if not import_local_lib('gams'):
@@ -89,6 +105,11 @@ def solve_GAMS(sim_folder, gams_folder=None, work_dir=None, output_lst=False):
 
 
 def solve_pyomo(sim_folder):
+    '''
+    Function used to run the optimization using the PYOMO engine. 
+    
+    :param sim_folcer: path to a valid Dispa-SET simulation folder
+    '''
     import pickle
     from .pyomo.model import DispaSolve
 

Docs/conf.py

@@ -25,6 +25,11 @@
 # Sets the __version__ variable
 exec(open('../DispaSET/_version.py').read())
 
+from subprocess import check_output
+try:
+    __release__ = check_output(["git", "describe"]).strip()
+except:
+    __release__ = None
 
 # -- General configuration ------------------------------------------------
 
@@ -64,7 +69,7 @@
 # The short X.Y version.
 version = __version__
 # The full version, including alpha/beta/rc tags.
-release = __version__
+release = __release__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Docs/index.rst

@@ -10,26 +10,35 @@ The Dispa-SET model is an open-source unit commitment and optimal dispatch model
 
 Dispa-SET is mainly developed within the Joint Research Centre of the EU Commission, in close collaboration with the University of Liège (Belgium).
 
-Model description and philosophy
---------------------------------
-A comprehensive description of the model is available in the 2017 JRC technical report: `Modelling Future EU Power Systems Under High Shares of Renewables`_.
-
-.. image:: figures/report2.jpg
-
 Downloading Dispa-SET
 ---------------------
 The public version of Dispa-SET can be downloaded in the :ref:`releases` section or from its github repository (using the Clone or Download button on the right side of the screen):
 https://github.com/energy-modelling-toolkit/Dispa-SET
-
+
+How to cite
+-----------
+Depending on the version that was used, one of the following JRC technical reports can be selected to cite Dispa-SET:
+
+- Kavvadias, K., Hidalgo Gonzalez, I., Zucker, A. and Quoilin, S., Integrated modelling of future EU power and heat systems: The Dispa-SET v2.2 open-source model, JRC Technical Report, EU Commission, 2018
+
+- Quoilin, S., Hidalgo Gonzalez, I. and Zucker, A., Modelling Future EU Power Systems Under High Shares of Renewables: The Dispa-SET 2.1 open-source model, JRC Technical Report, EU Commission, 2017
+
+- Hidalgo González, I., Quoilin, S. and Zucker, A., Dispa-SET 2.0: unit commitment and power dispatch model, Tech. rep., Publications Office of the European Union, 2014.
+
 Documentation
 -------------
-The model documentation is available by running sphinx in the Docs folder of the project or by consulting the online documentation. This documentation corresponds to the latest available public version of Dispa-SET: 
-http://www.dispaset.eu/latest/index.html
+A pdf documentation of the model is available in the 2017 JRC technical report: `Modelling Future EU Power Systems Under High Shares of Renewables`_.
+
+.. image:: figures/report2.jpg
 
+In addition, the lastest model documentation can be obtained by running sphinx in the Docs folder of the project or by consulting the online documentation. This documentation corresponds to the latest available public version of Dispa-SET: 
+http://www.dispaset.eu/latest/index.html
+
+
 Main contributors:
 ------------------
 
-* Sylvain Quoilin (University of Liège, Belgium)) 
+* `Sylvain Quoilin`_ (University of Liège, Belgium)) 
 
 * Konstantinos Kavvadias  (Joint Research Centre, EU Commission)
 
@@ -61,3 +70,5 @@ Indices and tables
 
 
 .. _Modelling Future EU Power Systems Under High Shares of Renewables: https://ec.europa.eu/jrc/en/publication/eur-scientific-and-technical-research-reports/modelling-future-eu-power-systems-under-high-shares-renewables-dispa-set-21-open-source
+
+.. _Sylvain Quoilin: http://www.squoilin.eu

Docs/overview.rst

@@ -4,8 +4,9 @@ Overview
 ========
 
 :Organization:  `Joint Research Centre`_,
-		`European Commission`_,
+		`European Commission`_
 :Version: |version|
+:Git Revision: |release|
 :Date: |today|
 
 The Dispa-SET model is mainly developed within the “Joint Research Centre” of the European Commission and focused on the balancing and flexibility problems in European grids [1]_.
@@ -42,6 +43,18 @@ Libraries used
 * `matplotlib`_ for plotting
 * `GAMS_api`_ for the communication with GAMS
 
+Dispa-SET in the scientific literature
+--------------------------------------
+
+In the past years, Dispa-SET has been used in various scientific works covering different geographical areas and with different focus points. The works for which scientific articles have been published are summarized hereunder:
+
+* Contribution of hydropower for flexibility services in the European power system [2]_.
+* Ongoing work aiming at coupling the JRC-EU-TIMES model with Dispa-SET by generating simplified variable RES flexibility constraints [3]_ [4]_.
+* Impact of Electric Vehicle deployment in The Netherlands [5]_.
+* Open-source model of the Balkans area, with some simulations involving high shares of renewables [6]_ [7]_.
+* Available technical flexibility to balance variable RES generation in Belgium [8]_
+
+
 
 Ongoing developments
 --------------------
@@ -65,23 +78,27 @@ can be redistributed and/or modified under the terms of this license.
 
 Main Developers
 ---------------
-- Sylvain Quoilin (University of Liège)
+- `Sylvain Quoilin`_ (University of Liège, KU Leuven)
 - Andreas Zucker (European Commission, Institute for Energy and Transport)
 - Konstantinos Kavvadias (European Commission, Institute for Energy and Transport)
 
 References
 ----------
 .. [1] Quoilin, S., Hidalgo Gonzalez, I., & Zucker, A. (2017). Modelling Future EU Power Systems Under High Shares of Renewables: The Dispa-SET 2.1 open-source models. Publications Office of the European Union.
-.. [2] Hidalgo González, I., Quoilin, S., & Zucker, A. (2014). Dispa-SET 2.0: unit commitment and power dispatch model (EUR 27015 EN). Petten, Netherlands: European Commission.
-.. [3] Quoilin, S., Nijs, W., Hidalgo, I., & Thiel, C. (2015). Evaluation of simplified flexibility evaluation tools using a unit commitment model. IEEE Digital Library.
-.. [4] Quoilin, S., Gonzalez Vazquez, I., Zucker, A., & Thiel, C. (2014). Available technical flexibility for balancing variable renewable energy sources: case study in Belgium. Proceedings of the 9th Conference on Sustainable Development of Energy, Water and Environment Systems.
+.. [2] Sánchez Pérez, A. (2017), Modelling Hydropower in detail to assess its contribution to flexibility services in the European power system. Master Thesis, University of Utrecht, Netherlands.
+.. [3] Quoilin, S., Nijs, W., Gonzalez, I. H., Zucker, A. and Thiel, C. (2015), Evaluation of simplified flexibility evaluation tools using a unit commitment model, In 12th International Conference on the European Energy Market (EEM), pp. 1 5.
+.. [4] Quoilin, S., Nijs, W. and Zucker, A. (2017), Evaluating flexibility and adequacy in future EU power systems: model coupling and long-term forecasting, In Proceedings of the 2017 ECOS Conference, San Diego.
+.. [5] Beltramo, A., Julea, A., Refa, N., Drossinos, Y., Thiel, C. and Quoilin, S. (2017),`Using electric vehicles as flexible resource in power systems: A case study in the Netherlands, In 14th International Conference on the European Energy Market (EEM).
+.. [6] Pavi£evi¢, M., Tomi¢, I., Quoilin, S., Zucker, A. and Puk2ec, T. (2017), Applying the Dispa-SET model on the Western Balkans power systems, In Proceedings of the 2017 SDEWES Conference
+.. [7] Tomi¢, I., Pavi£evi¢, M., Quoilin, S., Zucker, A., Kraja£i¢, G., Puk2ec, T. and Dui¢, N. (2017), Applying the Dispa-SET model on the seven countries from the South East Europe, In 8th Energy Planning and Modeling of Energy Systems-Meeting, Belgrade
+.. [8] Quoilin, S., Gonzalez Vazquez, I., Zucker, A., & Thiel, C. (2014). Available technical flexibility for balancing variable renewable energy sources: case study in Belgium. Proceedings of the 9th Conference on Sustainable Development of Energy, Water and Environment Systems.
 
 .. _matplotlib: http://matplotlib.org
 .. _pandas: http://pandas.pydata.org
 .. _pyomo: http://www.pyomo.org/
 .. _GAMS_api: http://www.gams.com/help/index.jsp?topic=%2Fgams.doc%2Fapis%2Findex.html
 .. _European Commission: https://ec.europa.eu/
 .. _Joint Research Centre: https://ec.europa.eu/jrc/en
-
+.. _Sylvain Quoilin: http://squoilin.eu
 
 

requirements.txt

@@ -6,4 +6,4 @@ pandas==0.21.0
 Sphinx==1.6.5
 sphinx-rtd-theme==0.1.9
 xlrd==0.9.4
-
+Pyomo==5.3