Release v0.1.0 (#188)

.github/workflows/tests-coverage.yml

@@ -0,0 +1,33 @@
+# Tests with pytest the package and monitors the covarage and sends it to coveralls.io
+# Coverage is only send to coveralls.io when no pytest tests fail
+name: "Tests & coverage"
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.7', '3.8', '3.9' ]
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip3 install -e $GITHUB_WORKSPACE[full]
+        pip3 install coveralls
+    - name: Run coverage
+      run: |  
+        coverage run --source=edisgo -m pytest --runslow -vv
+      #continue-on-error: true
+    - name: Run coveralls
+      run: |
+        coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_SERVICE_NAME: github

.gitignore

@@ -19,13 +19,18 @@ doc/_html
 
 # exclude egg-info
 eDisGo.egg-info/
-/edisgo/examples/Exemplary_PyPSA_bus_results.csv
-/edisgo/examples/Exemplary_PyPSA_line_results.csv
+/examples/Exemplary_PyPSA_bus_results.csv
+/examples/Exemplary_PyPSA_line_results.csv
 
 # exclude directories
-/edisgo/examples/edisgo2pypsa_export/*
-/edisgo/examples/data/
+/examples/edisgo2pypsa_export/*
+/examples/data/
+/examples/ding0_example_grid/
 
 # exclude check scripts
-/edisgo/examples/compare_graphs.py
-/edisgo/examples/compare_pypsa_network.py
+/examples/compare_graphs.py
+/examples/compare_pypsa_network.py
+
+# exclude .json files in opf
+/edisgo/opf/edisgo_scenario_data/*.json
+/edisgo/opf/opf_solutions/*.json

README.md

@@ -1,8 +1,14 @@
 <img align="right" width="200" height="200" src="https://github.com/openego/eDisGo/blob/dev/doc/images/edisgo_logo.png">
 
+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 provides a toolbox to analyze distribution grids for grid issues 
-and to evaluate measures responding these.
+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.
 
 

doc/api.rst

@@ -6,7 +6,12 @@ API
 .. make doc-string generated documentation appear here
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :glob:
 
-   api/*
+   api/edisgo_class
+   api/edisgo.network
+   api/edisgo.flex_opt
+   api/edisgo.io
+   api/edisgo.opf
+   api/edisgo.tools

doc/api/edisgo.flex_opt.rst

@@ -1,9 +1,6 @@
 edisgo.flex\_opt package
 ========================
 
-Submodules
-----------
-
 edisgo.flex\_opt.check\_tech\_constraints module
 ------------------------------------------------
 
@@ -20,14 +17,6 @@ edisgo.flex\_opt.costs module
     :undoc-members:
     :show-inheritance:
 
-edisgo.flex\_opt.curtailment module
------------------------------------
-
-.. automodule:: edisgo.flex_opt.curtailment
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 edisgo.flex\_opt.exceptions module
 ----------------------------------
 
@@ -51,35 +40,3 @@ edisgo.flex\_opt.reinforce\_measures module
     :members:
     :undoc-members:
     :show-inheritance:
-
-edisgo.flex\_opt.storage\_integration module
---------------------------------------------
-
-.. automodule:: edisgo.flex_opt.storage_integration
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-edisgo.flex\_opt.storage\_operation module
-------------------------------------------
-
-.. automodule:: edisgo.flex_opt.storage_operation
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-edisgo.flex\_opt.storage\_positioning module
-----------------------------------------------
-
-.. automodule:: edisgo.flex_opt.storage_positioning
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: edisgo.flex_opt
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/api/edisgo.io.rst

@@ -0,0 +1,34 @@
+edisgo.io package
+===================
+
+edisgo.io.ding0\_import module
+-------------------------------
+
+.. automodule:: edisgo.io.ding0_import
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.io.generators\_import module
+-----------------------------------
+
+.. automodule:: edisgo.io.generators_import
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.io.pypsa\_io module
+------------------------------
+
+.. automodule:: edisgo.io.pypsa_io
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.io.timeseries\_import module
+------------------------------------
+
+.. automodule:: edisgo.io.timeseries_import
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/edisgo.network.rst

@@ -0,0 +1,42 @@
+edisgo.network package
+=======================
+
+edisgo.network.components module
+----------------------------------
+
+.. automodule:: edisgo.network.components
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.network.grids module
+----------------------------
+
+.. automodule:: edisgo.network.grids
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.network.results module
+-------------------------------
+
+.. automodule:: edisgo.network.results
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.network.timeseries module
+---------------------------------
+
+.. automodule:: edisgo.network.timeseries
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.network.topology module
+---------------------------------
+
+.. automodule:: edisgo.network.topology
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/edisgo.opf.rst

@@ -0,0 +1,44 @@
+edisgo.opf package
+========================
+
+edisgo.opf.run\_mp\_opf module
+----------------------------------
+
+.. automodule:: edisgo.opf.run_mp_opf
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.opf.timeseries\_reduction module
+-------------------------------------------
+
+.. automodule:: edisgo.opf.timeseries_reduction
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.opf.results package
+-----------------------------
+
+.. automodule:: edisgo.opf.results.opf_expand_network
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: edisgo.opf.results.opf_result_class
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+edisgo.opf.util package
+----------------------------------
+
+.. automodule:: edisgo.opf.util.plot_solutions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: edisgo.opf.util.scenario_settings
+    :members:
+    :undoc-members:
+    :show-inheritance: