Skip to content

Commit

Permalink
Merge branch 'dev' of github.com:openego/eDisGo into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
birgits committed Jul 25, 2022
2 parents fe08db3 + 32ce206 commit fd356be
Show file tree
Hide file tree
Showing 87 changed files with 30,518 additions and 1,173 deletions.
1 change: 0 additions & 1 deletion .github/workflows/tests-coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ jobs:
- name: Run coverage
run: |
coverage run --source=edisgo -m pytest --runslow -vv
#continue-on-error: true
- name: Run coveralls
run: |
coveralls
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: "3.7"
version: "3.8"
install:
- requirements: rtd_requirements.txt
48 changes: 28 additions & 20 deletions doc/api/edisgo.flex_opt.rst
Original file line number Diff line number Diff line change
@@ -1,50 +1,58 @@
edisgo.flex\_opt package
========================

edisgo.flex\_opt.charging\_strategies module
--------------------------------------------

.. automodule:: edisgo.flex_opt.charging_strategies
:members:
:undoc-members:
:show-inheritance:

edisgo.flex\_opt.check\_tech\_constraints module
------------------------------------------------

.. automodule:: edisgo.flex_opt.check_tech_constraints
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.flex\_opt.costs module
-----------------------------

.. automodule:: edisgo.flex_opt.costs
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.flex\_opt.exceptions module
----------------------------------

.. automodule:: edisgo.flex_opt.exceptions
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.flex\_opt.q\_control module
----------------------------------
-----------------------------------

.. automodule:: edisgo.flex_opt.exceptions
:members:
:undoc-members:
:show-inheritance:
.. automodule:: edisgo.flex_opt.q_control
:members:
:undoc-members:
:show-inheritance:

edisgo.flex\_opt.reinforce\_grid module
---------------------------------------

.. automodule:: edisgo.flex_opt.reinforce_grid
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.flex\_opt.reinforce\_measures module
-------------------------------------------

.. automodule:: edisgo.flex_opt.reinforce_measures
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
40 changes: 24 additions & 16 deletions doc/api/edisgo.io.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
edisgo.io package
===================
=================

edisgo.io.ding0\_import module
-------------------------------
------------------------------

.. automodule:: edisgo.io.ding0_import
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.io.electromobility\_import module
----------------------------------------

.. automodule:: edisgo.io.electromobility_import
:members:
:undoc-members:
:show-inheritance:

edisgo.io.generators\_import module
-----------------------------------

.. automodule:: edisgo.io.generators_import
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.io.pypsa\_io module
------------------------------
--------------------------

.. automodule:: edisgo.io.pypsa_io
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.io.timeseries\_import module
------------------------------------
-----------------------------------

.. automodule:: edisgo.io.timeseries_import
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
50 changes: 29 additions & 21 deletions doc/api/edisgo.network.rst
Original file line number Diff line number Diff line change
@@ -1,42 +1,50 @@
edisgo.network package
=======================
======================

edisgo.network.components module
----------------------------------
--------------------------------

.. automodule:: edisgo.network.components
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.network.electromobility module
-------------------------------------

.. automodule:: edisgo.network.electromobility
:members:
:undoc-members:
:show-inheritance:

edisgo.network.grids module
----------------------------
---------------------------

.. automodule:: edisgo.network.grids
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.network.results module
-------------------------------
-----------------------------

.. automodule:: edisgo.network.results
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.network.timeseries module
---------------------------------
--------------------------------

.. automodule:: edisgo.network.timeseries
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

edisgo.network.topology module
---------------------------------
------------------------------

.. automodule:: edisgo.network.topology
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion doc/api/edisgo.opf.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
edisgo.opf package
========================
==================

edisgo.opf.run\_mp\_opf module
----------------------------------
Expand Down
6 changes: 3 additions & 3 deletions doc/api/edisgo.tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ edisgo.tools.edisgo\_run module
:show-inheritance:

edisgo.tools.geo module
-----------------------
------------------------

.. automodule:: edisgo.tools.geo
:members:
Expand All @@ -28,15 +28,15 @@ edisgo.tools.geo module
edisgo.tools.geopandas\_helper module
----------------------------------------

.. automodule:: edisgo.tools.geo
.. automodule:: edisgo.tools.geopandas_helper
:members:
:undoc-members:
:show-inheritance:

edisgo.tools.networkx\_helper module
----------------------------------------

.. automodule:: edisgo.tools.geo
.. automodule:: edisgo.tools.networkx_helper
:members:
:undoc-members:
:show-inheritance:
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
#
# 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 = "English"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down
4 changes: 4 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,16 @@ The toolbox currently includes:
feed-in time series of fluctuating renewables and scenarios for future
power plant park of Germany
* `demandlib <https://github.com/oemof/demandlib>`_ for electrical load time series
* `SimBEV <https://github.com/rl-institut/simbev>`_ and
`TracBEV <https://github.com/rl-institut/tracbev>`_ for charging demand data of electric
vehicles, respectively potential charging point locations

* Static, non-linear power flow analysis using `PyPSA <https://pypsa.org>`_ for
grid issue identification
* Automatic grid reinforcement methodology solving overloading and voltage issues
to determine grid expansion needs and costs based on measures most commonly
taken by German distribution grid operators
* Implementation of different charging strategies of electric vehicles
* Multiperiod optimal power flow based on julia package PowerModels.jl optimizing
storage positioning and/or operation (Currently not maintained)
as well as generator dispatch with regard to minimizing grid expansion costs
Expand Down
24 changes: 21 additions & 3 deletions doc/usage_details.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ features can be used.
The fundamental data structure
------------------------------

It's worth to understand how the fundamental data structure of eDisGo is
It's worth understanding how the fundamental data structure of eDisGo is
designed in order to make use of its entire features.

The class :class:`~.EDisGo` serves as the top-level API for
Expand All @@ -20,7 +20,12 @@ capacity, grid reinforcement and flexibility measures. It also provides
access to all relevant data.
Grid data is stored in the :class:`~.network.topology.Topology` class.
Time series data can be found in the :class:`~.network.timeseries.TimeSeries`
class. Results data holding results e.g. from the power flow analysis and grid
class.
The class :class:`~.network.electromobility.Electromobility` holds data on charging
processes (how long cars are parking at a charging station, how much they need to charge,
etc.) necessary to apply different charging strategies, as well as information on
potential charging sites and integrated charging parks.
Results data holding results e.g. from the power flow analysis and grid
expansion is stored in the :class:`~.network.results.Results` class.
Configuration data from the config files (see :ref:`default_configs`) is stored
in the :class:`~.tools.config.Config` class.
Expand All @@ -36,6 +41,9 @@ code examples `edisgo` constitues an :class:`~.EDisGo` object.
# Access TimeSeries data container object
edisgo.timeseries
# Access Electromobility data container object
edisgo.electromobility
# Access Results data container object
edisgo.results
Expand Down Expand Up @@ -250,8 +258,13 @@ Heuristic

Use this mode to use heuristics to set time series. So far, only heuristics for
electric vehicle charging are implemented.
The charging strategies can be invoked as follows:

.. code-block:: python
.. todo:: Add more details once the charging strategies are merged.
edisgo.apply_charging_strategy()
See :attr:`~.edisgo.EDisGo.apply_charging_strategy` for more information.

Reactive power time series
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -331,6 +344,11 @@ Costs for the grid expansion measures can be obtained as follows:
Further information on the grid reinforcement methodology can be found in section
:ref:`grid_expansion_methodology`.

Electromobility
-----------------

.. todo:: Add

Battery storage systems
------------------------

Expand Down
8 changes: 7 additions & 1 deletion doc/whatsnew/v0-2-0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ Changes
-------

* added pre-commit hooks (flake8, black, isort, pyupgrade) `#229 <https://github.com/openego/eDisGo/pull/229>`_
* added issue and pull request templates `#220 <https://github.com/openego/eDisGo/issues/220>`_
* added Windows installation yml and documentation
* added integrity checks of eDisGo object `#231 <https://github.com/openego/eDisGo/issues/231>`_
* added functionality to save to and load from zip archive `#216 <https://github.com/openego/eDisGo/pull/216>`_
* added option to not raise error in case power flow did not converge `#207 <https://github.com/openego/eDisGo/issues/207>`_
* added pyplot `#214 <https://github.com/openego/eDisGo/pull/214>`_
* added functionality to create geopandas dataframes `#224 <https://github.com/openego/eDisGo/issues/224>`_
* added tests
* major refactoring of loads and time series

Expand All @@ -21,5 +24,8 @@ Changes
* added simultaneity factors for heat pumps and electric vehicles
* grid reinforcement now considers separate simultaneity factors for dimensioning of LV and MV `#252 <https://github.com/openego/eDisGo/pull/252>`_


* added interface to electromobility data from tools SimBEV and TracBEV (SimBEV provides data on
standing times, charging demand, etc. per vehicle, whereas TracBEV provides potential charging point locations)
`#174 <https://github.com/openego/eDisGo/issues/174>`_ and
`#191 <https://github.com/openego/eDisGo/pull/191>`_

2 changes: 1 addition & 1 deletion eDisGo_env.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ channels:
dependencies:
- python = 3.8
- pip
- pandas >= 1.2, < 1.3
- pandas >= 1.2
- conda-forge::fiona
- conda-forge::geopy
- conda-forge::geopandas
Expand Down
2 changes: 1 addition & 1 deletion eDisGo_env_dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ channels:
dependencies:
- python = 3.8
- pip
- pandas >= 1.2, < 1.3
- pandas >= 1.2
- conda-forge::fiona
- conda-forge::geopy
- conda-forge::geopandas
Expand Down

0 comments on commit fd356be

Please sign in to comment.