Features/restructure time series

.github/workflows/tests-coverage.yml

@@ -19,6 +19,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
+        pip3 install --upgrade pip
         pip3 install -e $GITHUB_WORKSPACE[full]
         pip3 install coveralls
     - name: Run coverage

.pre-commit-config.yaml

@@ -6,13 +6,13 @@ repos:
   -   id: end-of-file-fixer
   -   id: trailing-whitespace
 - repo: https://github.com/psf/black
-  rev: 21.12b0
+  rev: 22.3.0
   hooks:
     - id: black
-#- repo: https://github.com/pycqa/flake8
-#  rev: 4.0.1
-#  hooks:
-#    - id: flake8
+- repo: https://github.com/pycqa/flake8
+  rev: 4.0.1
+  hooks:
+    - id: flake8
 - repo: https://github.com/pycqa/isort
   rev: 5.10.1
   hooks:

doc/api/edisgo.flex_opt.rst

@@ -20,6 +20,14 @@ edisgo.flex\_opt.costs module
 edisgo.flex\_opt.exceptions module
 ----------------------------------
 
+.. automodule:: edisgo.flex_opt.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.flex\_opt.q\_control module
+----------------------------------
+
 .. automodule:: edisgo.flex_opt.exceptions
     :members:
     :undoc-members:

doc/api/edisgo.tools.rst

@@ -20,6 +20,22 @@ edisgo.tools.edisgo\_run module
 edisgo.tools.geo module
 -----------------------
 
+.. automodule:: edisgo.tools.geo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.tools.geopandas\_helper module
+----------------------------------------
+
+.. automodule:: edisgo.tools.geo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.tools.networkx\_helper module
+----------------------------------------
+
 .. automodule:: edisgo.tools.geo
     :members:
     :undoc-members:
@@ -57,7 +73,6 @@ edisgo.tools.tools module
     :undoc-members:
     :show-inheritance:
 
-
 Module contents
 ---------------
 

doc/conf.py

@@ -28,7 +28,6 @@
 # serve to show the default.
 
 import os
-import shlex
 import sys
 
 from unittest.mock import MagicMock
@@ -55,6 +54,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",  # enable Napoleon Sphinx v>1.3
     "sphinx.ext.extlinks",  # enables external links with a key
+    "sphinx_autodoc_typehints",
 ]
 
 # Napoleon settings
@@ -76,8 +76,13 @@
         "http://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.%s.html",
         "pandas.",
     ),
+    "geopandas": (
+        "https://geopandas.org/en/stable/docs/reference/api/geopandas.%s.html",
+        "geopandas.",
+    ),
     "networkx": (
-        "https://networkx.github.io/documentation/stable/reference/classes/graph.html#%s",
+        "https://networkx.github.io/documentation/stable/reference/classes/"
+        "graph.html#%s",
         "networkx.",
     ),
     "sqlalchemy": (
@@ -86,7 +91,7 @@
     ),
     "shapely": ("https://shapely.readthedocs.io/en/latest/manual.html#%s", "shapely."),
     "ding0": ("https://dingo.readthedocs.io/en/dev/api/ding0.html#%s", "Ding0"),
-    "pypsa": ("https://pypsa.org/doc/components.html#%s", "pypsa"),
+    "pypsa": ("https://pypsa.readthedocs.io/en/latest/components.html#%s", "pypsa"),
     "plotly": ("https://plotly.com/python-api-reference/generated/#%s.html", "plotly"),
 }
 # Add any paths that contain templates here, relative to this directory.
@@ -104,9 +109,9 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"eDisGo"
-copyright = u"2017, open_eGo-Team"
-author = u"open_eGo-Team"
+project = "eDisGo"
+copyright = "2017, open_eGo-Team"
+author = "open_eGo-Team"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -162,8 +167,9 @@
 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:
 
     class Mock(MagicMock):
@@ -181,7 +187,7 @@ def __getattr__(cls, name):
 # a list of builtin themes.
 # html_theme = 'alabaster'
 
-import sphinx_rtd_theme
+import sphinx_rtd_theme  # noqa: E402
 
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_theme = "sphinx_rtd_theme"
@@ -282,20 +288,20 @@ 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
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "edisgo.tex", u"eDisGo Documentation", u"open_eGo-Team", "manual"),
+    (master_doc, "edisgo.tex", "eDisGo Documentation", "open_eGo-Team", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -323,7 +329,7 @@ def __getattr__(cls, name):
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "eDisGo", u"eDisGo Documentation", [author], 1)]
+man_pages = [(master_doc, "eDisGo", "eDisGo Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -338,7 +344,7 @@ def __getattr__(cls, name):
     (
         master_doc,
         "eDisGo",
-        u"eDisGo Documentation",
+        "eDisGo Documentation",
         author,
         "eDisGo",
         "One line description of project.",

doc/features_in_detail.rst

@@ -7,8 +7,7 @@ Power flow analysis
 -------------------
 
 In order to analyse voltages and line loadings a non-linear power flow analysis (PF) using pypsa is conducted.
-All loads and generators are modelled as PQ nodes; the slack is modelled as a PV node with a set voltage of 1\,p.u.
-and positioned at the substation's secondary side.
+All loads and generators are modelled as PQ nodes. The slack is positioned at the substation's secondary side.
 
 Multi period optimal power flow
 ---------------------------------
@@ -267,10 +266,14 @@ Storage integration
 
 .. warning:: The storage integration methods described below are not yet adapted to the refactored code and therefore currently do not work.
 
-Besides the possibility to connect a storage with a given operation to any node in the grid, eDisGo provides a methodology that takes
-a given storage capacity and allocates it to multiple smaller storages such that it reduces line overloading and voltage deviations.
-The methodology is implemented in :py:func:`~edisgo.flex_opt.storage_positioning.one_storage_per_feeder`. As the above described
-curtailment allocation methodologies it is intended to be used in combination with `eTraGo <https://github.com/openego/eTraGo>`_ where
+Besides the possibility to connect a storage with a given operation to any node in the
+grid, eDisGo provides a methodology that takes
+a given storage capacity and allocates it to multiple smaller storage units such that it
+reduces line overloading and voltage deviations.
+The methodology is implemented in :py:func:`~edisgo.flex_opt.storage_positioning.one_storage_per_feeder`.
+As the above described
+curtailment allocation methodologies it is intended to be used in combination
+with `eTraGo <https://github.com/openego/eTraGo>`_ where
 storage capacity and operation is optimized.
 
 For each feeder with load or voltage issues it is checked if integrating a