Features/heat pump integration (#271)

Co-authored-by: Malte Jahn <malte.jahn@rl-institut.de>
Co-authored-by: Kilian Helfenbein <46815982+khelfen@users.noreply.github.com>
Co-authored-by: Kilian Helfenbein <Kilian.Helfenbein@rl-institut.de>
Co-authored-by: AnyaHe <anya.heider@rl-institut.de>
Co-authored-by: Anya Heider <50416149+AnyaHe@users.noreply.github.com>

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+extend-exclude = docs
+max-line-length = 88
+extend-ignore = E203
+count = true
+statistics = true
+show-source = true

.github/workflows/tests-coverage.yml

@@ -3,7 +3,7 @@
 name: "Tests & coverage"
 
 on: [push]
-  
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -19,10 +19,11 @@ 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
-      run: |  
+      run: |
         coverage run --source=edisgo -m pytest --runslow -vv
       #continue-on-error: true
     - name: Run coveralls

.gitignore

@@ -13,6 +13,7 @@
 *.woff
 *.css
 *.pkl
+*.ipynb_checkpoints
 
 # exclude locally built docs
 doc/_html

.isort.cfg

@@ -0,0 +1,4 @@
+[settings]
+profile = black
+multi_line_output = 3
+lines_between_types = 1

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+  -   id: check-yaml
+  -   id: end-of-file-fixer
+  -   id: trailing-whitespace
+- repo: https://github.com/psf/black
+  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/isort
+  rev: 5.10.1
+  hooks:
+    - id: isort
+      name: isort (python)
+- repo: https://github.com/asottile/pyupgrade
+  rev: v2.31.0
+  hooks:
+    - id: pyupgrade
+#- repo: https://github.com/pycqa/pylint
+#  rev: pylint-2.6.0
+#  hooks:
+#    - id: pylint

.readthedocs.yml

@@ -20,4 +20,4 @@ formats: all
 python:
   version: "3.7"
   install:
-    - requirements: rtd_requirements.txt
+    - requirements: rtd_requirements.txt

README.md

@@ -1,19 +1,21 @@
 <img align="right" width="200" height="200" src="https://raw.githubusercontent.com/openego/eDisGo/dev/doc/images/edisgo_logo.png">
 
-Overview
-========
+
+# Overview
+
 [![Coverage Status](https://coveralls.io/repos/github/openego/eDisGo/badge.svg?branch=dev)](https://coveralls.io/github/openego/eDisGo?branch=dev)
 [![Tests & coverage](https://github.com/openego/eDisGo/actions/workflows/tests-coverage.yml/badge.svg)](https://github.com/openego/eDisGo/actions/workflows/tests-coverage.yml)
 
+
 # eDisGo
+
 The python package eDisGo serves as a toolbox to evaluate flexibility measures
 as an economic alternative to conventional grid expansion in
 medium and low voltage grids.
 See [documentation](https://edisgo.readthedocs.io/en/dev/) for further information.
 
 
-LICENSE
--------
+# LICENSE
 
 Copyright (C) 2017 Reiner Lemoine Institut gGmbH
 
@@ -29,4 +31,3 @@ details.
 
 You should have received a copy of the GNU General Public License along with
 this program. If not, see https://www.gnu.org/licenses/.
-

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/api/edisgo_class.rst

@@ -2,4 +2,4 @@ EDisGo class
 ============
 
 .. autoclass:: edisgo.EDisGo
-    :members:
+    :members: