Update dependencies and scenario_settings

Author: birgits

doc/api/modules.rst

@@ -49,22 +49,20 @@ The file can be found on
 
    This section of :json:object:`scenario_setting.json` contains all input parameters for the eDisGo tool and the clustering of MV grids.
 
-   :property string db: Name of your database (e.g.``''oedb''``). eDisGo queries generator data from this database. Please note that this parameters is automatically overwritten in eDisGo's configuration files.
-   :property string gridversion: ``null`` or *open_eGo* dataset version (e.g. ``''v0.4.5''``). If ``null``, *open_eGo*'s model_draft is used. Please note that this parameters is automatically overwritten in eDisGo's configuration files.
+   :property string gridversion: This parameter is currently not used.
    :property string grid_path: Path to the MV grid files (created by `ding0 <https://readthedocs.org/projects/dingo/>`_) (e.g. ``''data/MV_grids/20180713110719''``)
    :property string choice_mode: Mode that eGo uses to chose MV grids out of the files in **grid_path** (e.g. ``''manual''``, ``''cluster''`` or ``''all''``). If ``''manual''`` is chosen, the parameter **manual_grids** must contain a list of the desired grids. If ``''cluster''`` is chosen, **no_grids** must specify the desired number of clusters and **cluster_attributes** must specify the applied cluster attributes. If ``''all''`` is chosen, all MV grids from **grid_path** are calculated.
-   :property list cluster_attributes: List of strings containing the desired cluster attributes. Available attributes are: ``''farthest_node''``, ``''wind_cap''``, ``''solar_cap''`` and ``''extended_storage''``, thus an exemplary list looks like ``["farthest_node", "wind_cap", "solar_cap", "extended_storage"]``. ``''farthest_node''`` represents the longest path within each grid, ``''wind_cap''`` the installed wind capacity within each grid, ``''solar_cap''`` the installed solar capacity within each grid and ``''extended_storage''`` the installed storage units (as calculated by eTraGo). Please note that ``''extended_storage''`` is only available in combination with eTraGo datasets that optimized storage extension. Otherwise this attribute is ignored.
+   :property list cluster_attributes: List of strings containing the desired cluster attributes. Available attributes are all attributes returned from :py:func:`~ego.mv_clustering.mv_clustering.get_cluster_attributes.
    :property bool only_cluster: If ``true``, eGo only identifies cluster results, but performs no eDisGo run. Please note that for **only_cluster** an eTraGo run or dataset must be provided.
-   :property list manual_grids: List of MV grid ID's (*open_eGo* HV/MV substation ID's) is case of **choice_mode** = ``''manual''`` (e.g. ``[1718,1719]``). Ohterwise this parameter is ignored.
-   :property int no_grids: Number of MV grid clusters (from all grids in **grid_path**, a specified number of representative clusters is calculated) in case of **choice_mode** = ``''cluster''``. Otherwise this parameter is ignored.
+   :property list manual_grids: List of MV grid ID's in case of **choice_mode** = ``''manual''`` (e.g. ``[1718,1719]``). Ohterwise this parameter is ignored.
+   :property int n_clusters: Number of MV grid clusters (from all grids in **grid_path**, a specified number of representative clusters is calculated) in case of **choice_mode** = ``''cluster''``. Otherwise this parameter is ignored.
    :property bool parallelization: If ``false``, eDisgo is used in a consecutive way (this may take very long time). In order to increase the performance of MV grid simulations, ``true`` allows the parallel calculation of MV grids. If **parallelization** = ``true``, **max_calc_time** and **max_workers** must be specified.
    :property float max_calc_time: Maximum calculation time in hours for eDisGo simulations. The calculation is terminated after this time and all costs are extrapolated based on the unfinished simulation. Please note that this parameter is only used if **parallelization** = ``true``.
    :property ing max_workers: Number of workers (cpus) that are allocated to the simulation. If the given value exceeds the number of available workers, it is reduced to the number of available workers. Please note that this parameter is only used if **parallelization** = ``true``.
-   :property bool initial_reinforcement: This parameter must be set ``true``.
    :property float max_cos_phi_renewable: Maximum power factor for wind and solar generators in MV grids (e.g. ``0.9``). If the reactive power (as calculated by eTraGo) exceeds this power factor, the reactive power is reduced in order to reach the power factor conditions.
    :property string solver: Solver eDisGo uses to optimize the curtailment and storage integration (e.g. ``''gurobi''``).
-   :property string timesteps_pfa: Method eDisGo uses for the storage integration (e.g. ``''snapshot_analysis''``).
    :property string results: Path to folder where eDisGo's results will be saved.
+   :property list tasks: List of string defining the tasks to run. The eDisGo calculation for each MV grid can be devided into separate tasks which is helpful in case one tasks fails and calculations do not need to started in the beginning. The following tasks exist: ``''1_setup_grid''``, ``''2_specs_overlying_grid''``, ``''3_temporal_complexity_reduction''``, ``''4_optimisation''``, ``''5_grid_reinforcement''``.
 
 
 

doc/conf.py

@@ -6,7 +6,11 @@
 The documentation is available on RTD: https://openego.readthedocs.io"""
 
 
-__copyright__ = "Flensburg University of Applied Sciences, Europa-Universität Flensburg, Centre for Sustainable Energy Systems, DLR-Institute for Networked Energy Systems"
+__copyright__ = (
+    "Flensburg University of Applied Sciences, Europa-Universität "
+    "Flensburg, Centre for Sustainable Energy Systems, DLR-Institute "
+    "for Networked Energy Systems"
+)
 __license__ = "GNU Affero General Public License Version 3 (AGPL-3.0)"
 __author__ = "wolf_bunke"
 
@@ -26,11 +30,12 @@
 # serve to show the default.
 
 import os
-import shlex
 import sys
 
 from unittest.mock import MagicMock
 
+import sphinx_rtd_theme
+
 # from mock import Mock as MagicMock
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -56,9 +61,7 @@
     "sphinx.ext.imgmath",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
-    #    'sphinxcontrib.napoleon',#enable Napoleon interpreter of docstrings Sphinx v<=1.2
     "sphinx.ext.napoleon",  # enable Napoleon Sphinx v>1.3
-    #    'sphinx_paramlinks',#to have links to the types of the parameters of the functions
     "numpydoc",
     "sphinxcontrib.httpdomain",  # for restfull API
     "sphinxcontrib.autohttp.flask",
@@ -95,6 +98,7 @@
     "shapely": ("http://toblerity.org/shapely/manual.html#%s", "Shapely object"),
 }
 
+
 # test oedb implementation
 def rstjinja(app, docname, source):
     """
@@ -117,7 +121,6 @@ def setup(app):
 # oep_url= 'http://oep.iks.cs.ovgu.de/'
 
 # get data from oedb test
-# power_class = requests.get(oep_url+'/api/v0/schema/model_draft/tables/ego_power_class/rows/', ).json()
 
 # import json
 # path = os.getcwd()
@@ -173,7 +176,7 @@ def setup(app):
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -213,8 +216,10 @@ def setup(app):
 todo_include_todos = True
 
 
-# Fix import error of modules which depend on C modules (mock out the imports for these modules)
-# see http://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
+# Fix import error of modules which depend on C modules (mock out the imports for
+# these modules)
+# see http://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-
+# errors-on-libraries-that-depend-on-c-modules
 
 
 if "READTHEDOCS" in os.environ:
@@ -246,8 +251,6 @@ def __getattr__(cls, name):
 # a list of builtin themes.
 # html_theme = 'alabaster'
 
-import sphinx_rtd_theme
-
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_theme = "sphinx_rtd_theme"
 
@@ -347,13 +350,13 @@ def __getattr__(cls, name):
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    # 'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
+    # 'preamble': '',
     # Latex figure (float) alignment
-    #'figure_align': 'htbp',
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples

ego/scenario_setting.json

@@ -126,8 +126,6 @@
     "comments": null
 },
   "eDisGo": {
-    "db": "oedb",
-    "gridversion": "v0.4.5",
     "grid_path": "/path/to_your/.dingo/grids",
     "choice_mode": "cluster",
     "cluster_attributes":["pv_capacity_expansion_mw_per_km2", "wind_capacity_expansion_mw_per_km2", "electromobility_max_load_expansion_mw_per_km2", "pth_capacity_expansion_mw_per_km2"],
@@ -140,7 +138,8 @@
     "max_cos_phi_renewable": 0.9,
     "results": "results/another_result",
     "solver": "gurobi",
-    "tasks": ["1_setup_grid", "2_specs_overlying_grid", "3_temporal_complexity_reduction", "4_optimisation", "5_grid_reinforcement"]
+    "tasks": ["1_setup_grid", "2_specs_overlying_grid", "3_temporal_complexity_reduction", "4_optimisation", "5_grid_reinforcement"],
+    "gridversion": "v0.4.5"
   },
   "database": {
     "database_name": "<database_name>",

ego/tools/edisgo_integration.py

@@ -46,8 +46,6 @@
 import multiprocess as mp2
 import pandas as pd
 
-from sqlalchemy.orm import scoped_session, sessionmaker
-
 if "READTHEDOCS" not in os.environ:
     from edisgo.edisgo import import_edisgo_from_files
     from edisgo.flex_opt.reinforce_grid import enhanced_reinforce_grid
@@ -62,7 +60,6 @@
         aggregate_district_heating_components,
         reduce_timeseries_data_to_given_timeindex,
     )
-    from egoio.tools import db
 
     from ego.mv_clustering import cluster_workflow, database
     from ego.tools.economics import edisgo_grid_investment
@@ -378,21 +375,6 @@ def _update_edisgo_configs(self, edisgo_grid):
             self._suppress_log = False  # Only in the first run warnings and
             # info get thrown
 
-        # Database section
-        ego_db = self._db_section
-        edisgo_db = edisgo_grid.network.config["db_connection"]["section"]
-
-        if not ego_db == edisgo_db:
-            if not self._suppress_log:
-                logger.warning(
-                    (
-                        "eDisGo database configuration (db: '{}') "
-                        + "will be overwritten with database configuration "
-                        + "from eGo's scenario settings (db: '{}')"
-                    ).format(edisgo_db, ego_db)
-                )
-            edisgo_grid.network.config["db_connection"]["section"] = ego_db
-
         # Versioned
         ego_gridversion = self._grid_version
         if ego_gridversion is None:
@@ -477,7 +459,6 @@ def _set_scenario_settings(self):
 
         # Reading all eDisGo settings
         # TODO: Integrate into a for-loop
-        self._db_section = self._edisgo_args["db"]
         self._grid_version = self._edisgo_args["gridversion"]
         self._solver = self._edisgo_args["solver"]
         self._grid_path = self._edisgo_args["grid_path"]
@@ -538,11 +519,6 @@ def _cluster_mv_grids(self):
 
     def _identify_extended_storages(self):
 
-        conn = db.connection(section=self._db_section)
-        session_factory = sessionmaker(bind=conn)
-        Session = scoped_session(session_factory)
-        session = Session()
-
         all_mv_grids = self._check_available_mv_grids()
 
         storages = pd.DataFrame(index=all_mv_grids, columns=["storage_p_nom"])
@@ -570,8 +546,6 @@ def _identify_extended_storages(self):
 
             storages.at[mv_grid, "storage_p_nom"] = stor_p_nom
 
-        Session.remove()
-
         return storages
 
     def _check_available_mv_grids(self):

requirements.txt

@@ -2,8 +2,6 @@
 # Using single requirments for docs, see:
 # https://github.com/rtfd/readthedocs.org/issues/2070
 sphinx_rtd_theme
-pandas >=0.20.3, <=0.20.3
-pypsa  >= 0.11.0, <= 0.11.0
 numpy
 numpydoc
 sphinxcontrib-httpdomain

setup.py

@@ -29,7 +29,7 @@ def read(fname):
     "flake8",
 ]
 
-doc_req = []
+doc_req = ["numpydoc", "sphinxcontrib.httpdomain", "sphinx-jsondomain"]
 
 full_req = list(set(dev_req + doc_req))
 
@@ -55,9 +55,6 @@ def read(fname):
     install_requires=req,
     extras_require=extras,
     package_data={
-        "ego": [os.path.join("tools", "*.csv")]
-        + [os.path.join("tools", "*.json")]
-        + [os.path.join("", "*.json")],
-        "ego.data": ["*.csv"],
+        "ego": [os.path.join("tools", "*.json")] + [os.path.join("", "*.json")],
     },
 )