Skip to content

Commit 65b7dbd

Browse files
author
Birgit Schachler
authored
Release v0.1.0 (#188)
1 parent f64d30b commit 65b7dbd

File tree

168 files changed

+74778
-16029
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+74778
-16029
lines changed

‎.github/workflows/tests-coverage.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Tests with pytest the package and monitors the covarage and sends it to coveralls.io
2+
# Coverage is only send to coveralls.io when no pytest tests fail
3+
name: "Tests & coverage"
4+
5+
on: [push]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
strategy:
11+
matrix:
12+
python-version: [ '3.7', '3.8', '3.9' ]
13+
steps:
14+
- name: Checkout repo
15+
uses: actions/checkout@v2
16+
- name: Set up Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: ${{ matrix.python-version }}
20+
- name: Install dependencies
21+
run: |
22+
pip3 install -e $GITHUB_WORKSPACE[full]
23+
pip3 install coveralls
24+
- name: Run coverage
25+
run: |
26+
coverage run --source=edisgo -m pytest --runslow -vv
27+
#continue-on-error: true
28+
- name: Run coveralls
29+
run: |
30+
coveralls
31+
env:
32+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33+
COVERALLS_SERVICE_NAME: github

‎.gitignore‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,18 @@ doc/_html
1919

2020
# exclude egg-info
2121
eDisGo.egg-info/
22-
/edisgo/examples/Exemplary_PyPSA_bus_results.csv
23-
/edisgo/examples/Exemplary_PyPSA_line_results.csv
22+
/examples/Exemplary_PyPSA_bus_results.csv
23+
/examples/Exemplary_PyPSA_line_results.csv
2424

2525
# exclude directories
26-
/edisgo/examples/edisgo2pypsa_export/*
27-
/edisgo/examples/data/
26+
/examples/edisgo2pypsa_export/*
27+
/examples/data/
28+
/examples/ding0_example_grid/
2829

2930
# exclude check scripts
30-
/edisgo/examples/compare_graphs.py
31-
/edisgo/examples/compare_pypsa_network.py
31+
/examples/compare_graphs.py
32+
/examples/compare_pypsa_network.py
33+
34+
# exclude .json files in opf
35+
/edisgo/opf/edisgo_scenario_data/*.json
36+
/edisgo/opf/opf_solutions/*.json

‎README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
<img align="right" width="200" height="200" src="https://github.com/openego/eDisGo/blob/dev/doc/images/edisgo_logo.png">
22

3+
Overview
4+
========
5+
[![Coverage Status](https://coveralls.io/repos/github/openego/eDisGo/badge.svg?branch=dev)](https://coveralls.io/github/openego/eDisGo?branch=dev)
6+
[![Tests & coverage](https://github.com/openego/eDisGo/actions/workflows/tests-coverage.yml/badge.svg)](https://github.com/openego/eDisGo/actions/workflows/tests-coverage.yml)
7+
38
# eDisGo
4-
The python package eDisGo provides a toolbox to analyze distribution grids for grid issues
5-
and to evaluate measures responding these.
9+
The python package eDisGo serves as a toolbox to evaluate flexibility measures
10+
as an economic alternative to conventional grid expansion in
11+
medium and low voltage grids.
612
See [documentation](https://edisgo.readthedocs.io/en/dev/) for further information.
713

814

‎doc/api.rst‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ API
66
.. make doc-string generated documentation appear here
77
88
.. toctree::
9-
:maxdepth: 1
9+
:maxdepth: 2
1010
:glob:
1111

12-
api/*
12+
api/edisgo_class
13+
api/edisgo.network
14+
api/edisgo.flex_opt
15+
api/edisgo.io
16+
api/edisgo.opf
17+
api/edisgo.tools

‎doc/api/edisgo.data.rst‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎doc/api/edisgo.flex_opt.rst‎

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
edisgo.flex\_opt package
22
========================
33

4-
Submodules
5-
----------
6-
74
edisgo.flex\_opt.check\_tech\_constraints module
85
------------------------------------------------
96

@@ -20,14 +17,6 @@ edisgo.flex\_opt.costs module
2017
:undoc-members:
2118
:show-inheritance:
2219

23-
edisgo.flex\_opt.curtailment module
24-
-----------------------------------
25-
26-
.. automodule:: edisgo.flex_opt.curtailment
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
3120
edisgo.flex\_opt.exceptions module
3221
----------------------------------
3322

@@ -51,35 +40,3 @@ edisgo.flex\_opt.reinforce\_measures module
5140
:members:
5241
:undoc-members:
5342
:show-inheritance:
54-
55-
edisgo.flex\_opt.storage\_integration module
56-
--------------------------------------------
57-
58-
.. automodule:: edisgo.flex_opt.storage_integration
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:
62-
63-
edisgo.flex\_opt.storage\_operation module
64-
------------------------------------------
65-
66-
.. automodule:: edisgo.flex_opt.storage_operation
67-
:members:
68-
:undoc-members:
69-
:show-inheritance:
70-
71-
edisgo.flex\_opt.storage\_positioning module
72-
----------------------------------------------
73-
74-
.. automodule:: edisgo.flex_opt.storage_positioning
75-
:members:
76-
:undoc-members:
77-
:show-inheritance:
78-
79-
Module contents
80-
---------------
81-
82-
.. automodule:: edisgo.flex_opt
83-
:members:
84-
:undoc-members:
85-
:show-inheritance:

‎doc/api/edisgo.grid.rst‎

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎doc/api/edisgo.io.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
edisgo.io package
2+
===================
3+
4+
edisgo.io.ding0\_import module
5+
-------------------------------
6+
7+
.. automodule:: edisgo.io.ding0_import
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
edisgo.io.generators\_import module
13+
-----------------------------------
14+
15+
.. automodule:: edisgo.io.generators_import
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
edisgo.io.pypsa\_io module
21+
------------------------------
22+
23+
.. automodule:: edisgo.io.pypsa_io
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
edisgo.io.timeseries\_import module
29+
------------------------------------
30+
31+
.. automodule:: edisgo.io.timeseries_import
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎doc/api/edisgo.network.rst‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
edisgo.network package
2+
=======================
3+
4+
edisgo.network.components module
5+
----------------------------------
6+
7+
.. automodule:: edisgo.network.components
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
edisgo.network.grids module
13+
----------------------------
14+
15+
.. automodule:: edisgo.network.grids
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
edisgo.network.results module
21+
-------------------------------
22+
23+
.. automodule:: edisgo.network.results
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
edisgo.network.timeseries module
29+
---------------------------------
30+
31+
.. automodule:: edisgo.network.timeseries
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
edisgo.network.topology module
37+
---------------------------------
38+
39+
.. automodule:: edisgo.network.topology
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:

‎doc/api/edisgo.opf.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
edisgo.opf package
2+
========================
3+
4+
edisgo.opf.run\_mp\_opf module
5+
----------------------------------
6+
7+
.. automodule:: edisgo.opf.run_mp_opf
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
edisgo.opf.timeseries\_reduction module
13+
-------------------------------------------
14+
15+
.. automodule:: edisgo.opf.timeseries_reduction
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
edisgo.opf.results package
21+
-----------------------------
22+
23+
.. automodule:: edisgo.opf.results.opf_expand_network
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
.. automodule:: edisgo.opf.results.opf_result_class
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:
32+
33+
edisgo.opf.util package
34+
----------------------------------
35+
36+
.. automodule:: edisgo.opf.util.plot_solutions
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
41+
.. automodule:: edisgo.opf.util.scenario_settings
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:

0 commit comments

Comments
 (0)