doc fixes

Docs/overview.rst

@@ -5,8 +5,7 @@ Overview
 
 :Organization:  `Joint Research Centre`_,
 		`European Commission`_
-:Version: |version|
-:Git Revision: |release|
+:Version: |version| (|release|)
 :Date: |today|
 
 The Dispa-SET model is mainly developed within the “Joint Research Centre” of the European Commission and focuses on the balancing and flexibility problems in European grids [1]_.
@@ -117,7 +116,7 @@ References
 .. _Python 3.7: https://www.anaconda.com/distribution/
 .. _matplotlib: http://matplotlib.org
 .. _pandas: http://pandas.pydata.org
-.. _GAMS_api: http://www.gams.com/help/index.jsp?topic=%2Fgams.doc%2Fapis%2Findex.html
+.. _GAMS_api: https://github.com/kavvkon/gams-api
 .. _European Commission: https://ec.europa.eu/
 .. _Joint Research Centre: https://ec.europa.eu/jrc/en
 .. _Sylvain Quoilin: http://squoilin.eu

dispaset/preprocessing/preprocessing.py

@@ -24,19 +24,18 @@
 
 
 def build_simulation(config, mts_plot=None):
-    '''
+    """
     Dispa-SET function that builds different simulation environments based on the hydro scheduling option in the config file
     Hydro scheduling options:
-        Off      -  Hydro scheduling turned off, normal call of BuildSimulation function
-        Zonal    -  Zonal variation of hydro scheduling, if zones are not individually specified in a list (e.a. zones = ['AT','DE'])
-                    hydro scheduling is imposed on all active zones from the Config file
-        Regional -  Regional variation of hydro scheduling, if zones from a specific region are not individually specified in a list
-                    (e.a. zones = ['AT','DE']), hydro scheduling is imposed on all active zones from the Config file simultaneously
+
+    * Off      -  Hydro scheduling turned off, normal call of BuildSimulation function
+    * Zonal    -  Zonal variation of hydro scheduling, if zones are not individually specified in a list (e.a. zones = ['AT','DE']) hydro scheduling is imposed on all active zones from the Config file
+    * Regional -  Regional variation of hydro scheduling, if zones from a specific region are not individually specified in a list (e.a. zones = ['AT','DE']), hydro scheduling is imposed on all active zones from the Config file simultaneously
 
     :config:                    Read config file
     :zones_mts:                 List of zones where new reservoir levels should be calculated eg. ['AT','BE',...'UK']
     :mts_plot:                  If ms_plot = True indicative plot with temporary computed reservoir levels is displayed
-    '''
+    """
     y_start, m_start, d_start, __, __, __ = config['StartDate']
     y_stop, m_stop, d_stop, __, __, __ = config['StopDate']
     # Check existance of hydro scheduling module in the config file

dispaset/preprocessing/utils.py

@@ -1,9 +1,3 @@
-"""
-This file gathers different functions used in the DispaSET pre-processing tools
-
-@author: Sylvain Quoilin (sylvain.quoilin@ec.europa.eu)
-"""
-
 from __future__ import division
 
 import logging
@@ -23,9 +17,8 @@ def EfficiencyTimeSeries(config,plants,Temperatures):
     Function that calculates an efficiency time series for each unit
     In case of generation unit, the efficiency is constant in time (for now)
     In case of of p2h units, the efficicncy is defined as the COP, which can be
-    temperature-dependent or not
-    If it is temperature-dependent, the formula is:
-        COP = COP_nom + coef_a * (T-T_nom) + coef_b * (T-T_nom)^2
+    temperature-dependent or not. If it is temperature-dependent, the formula is:
+    :math:`COP = COP_{nom} + coef_a (T-T_{nom}) + coef_b (T-T_{nom})^2`
     
     :param plants:          Pandas dataframe with the original list of units
     :param Temperatures:    Dataframe with the temperature for all relevant units