Merge branch 'dev' into features/analyse_results_functions

.github/workflows/ci.yaml

@@ -52,3 +52,7 @@ jobs:
         run: "python -m nox -s build"
         env:
           PLATFORM: ${{ matrix.os.image }}
+      - name: "Install the package"
+        run: "python -m nox -s install"
+        env:
+          PLATFORM: ${{ matrix.os.image }}

README.rst

@@ -19,14 +19,16 @@ eTraGo
 Optimization of flexibility options for transmission grids based on PyPSA
 
 A speciality in this context is that transmission grids are described by the
-380, 220 and 110 kV in Germany. Conventionally the 110kV grid is part of the
+380, 220 and 110 kV in Germany. Conventionally, the 110kV grid is part of the
 distribution grid. The integration of the transmission and 'upper' distribution
 grid is part of eTraGo.
 
 The focus of optimization are flexibility options with a special focus on
 energy storages. Grid expansion measures are not part of this tool and will be
 instead part of 'eGo' https://github.com/openego/eGo
 
+eTraGo is documented on `readthedocs <https://etrago.readthedocs.io>`_.
+
 .. warning::
   From now on eTraGo depends on a sector coupled data-model. This is not published on 
   the oedb yet, the data has to be created using
@@ -35,7 +37,6 @@ instead part of 'eGo' https://github.com/openego/eGo
 
   When you want to use eTraGo for optimizations, please use the latest release 0.8.0. 
 
-
 Installation
 ============
 eTraGo is designed as a Python package therefore it is mandatory to have
@@ -88,7 +89,7 @@ you create a virtual environment (where you like it) and activate it:
 
 .. code-block:: bash
 
-   $ virtualenv venv --clear -p python3.7
+   $ virtualenv venv --clear -p python3.8
    $ source venv/bin/activate
    $ cd venv
 

doc/about.rst

@@ -15,15 +15,17 @@ energy storage and grid expansion measures.
 
 
 
-The open_eGo project
+Research projects
 ====================
-This software project is part of the research project
+This software project was initially developed in the research project
 `open_eGo <https://openegoproject.wordpress.com>`_.
+It is constantly further developed in different reserach projects, 
+e.g. `eGon <https://ego-n.org/>`_ and `PoWerD <https://www.h2-powerd.de/>`_. 
 
 
 The OpenEnergy Platform
 =======================
-Within this project we developed the OpenEnergy Platform which this software
+Within the open_eGo project we developed the OpenEnergy Platform which this software
 is using in order to get and store the in- and output data. Before you start to
 calculate a registration on the platform is needed. For more information see
 `openenergy-platform <https://openenergy-platform.org/>`_ and login.
@@ -39,12 +41,12 @@ this platform.
 
 
 
-Model overview
-==============
+Tool overview
+=============
 
 
 
-.. figure:: images/eTraGo_model.png
+.. figure:: images/ego_tools.svg
    :align: center
    :scale: 75%
 
@@ -63,17 +65,18 @@ eGo
 The python package eGo is a toolbox and application which connects the tool eTraGo
 (optimization of flexibility options at transmission grid level)
 and eDisGo (optimization of distribution grids). All those python
-packages are part of the research project 
+packages were initially developed in the research project 
 `open_eGo <https://openegoproject.wordpress.com>`_. 
 `Learn more here <http://openego.readthedocs.io/>`_.
 
 
-Dataprocessing
-==============
+Data model creation
+===================
+For the eGon project the python-tool `eGon-data <https://github.com/openego/eGon-data>`_ was implemented, which creates input data  for the optimization tools `eTraGo <https://github.com/openego/eTraGo>`_, `ding0 <https://github.com/openego/ding0>`_ and `eDisGo <https://github.com/openego/eDisGo>`_ and delivers for example data on grid topologies, demands/demand curves and generation capacities in a high spatial resolution. The outputs of egon-data are published under open source and open data licenses. 
+
+eGon-data is a further development of the `Data processing <https://github.com/openego/data_processing>`_ developed in the former research project `open_eGo <https://openegoproject.wordpress.com/>`_. It aims for an extensions of the data models as well as for a better replicability and manageability of the data preparation and processing. 
+The resulting data set serves as an input for the optimization tools `eTraGo <https://github.com/openego/eTraGo>`_, `ding0 <https://github.com/openego/ding0>`_ and `eDisGo <https://github.com/openego/eDisGo>`_ and delivers for example data on grid topologies, demands/demand curves and generation capacities in a high spatial resolution. The outputs of egon-data are published under open source and open data licenses.  
 
-For the open_eGo project several python packages are developed which are feeded 
-by the input data of the data processing. The Dataprocessing is writen in 
-SQL and Python. `Learn more here <https://data-processing.readthedocs.io/>`_.
 
 ego.io
 ======
@@ -97,7 +100,7 @@ medium and low voltage power distribution grids based on open
 LICENSE
 =======
 
-© Copyright 2015-2018
+© Copyright 2015-2023
 Flensburg University of Applied Sciences,
 Europa-Universität Flensburg,
 Centre for Sustainable Energy Systems and

doc/api.rst

@@ -1,8 +1,11 @@
-.. make doc-string generated documentation appear here
+API
+====
 
 .. toctree::
    :maxdepth: 7
    :glob:
    :titlesonly:
 
-   API <api/modules>
+   api/etrago.cluster
+   api/etrago.tools
+   api/appl.rst

doc/api/appl.rst

@@ -0,0 +1,7 @@
+etrago.appl module
+-------------------
+
+.. automodule:: etrago.appl
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/etrago.cluster.rst

@@ -1,30 +1,42 @@
-etrago\.cluster package
+etrago.cluster package
 =======================
 
-Submodules
-----------
+etrago.cluster.disaggregation module
+-----------------------------------------
 
-etrago\.cluster\.networkclustering module
+.. automodule:: etrago.cluster.disaggregation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.cluster.electrical module
 -----------------------------------------
 
-.. automodule:: etrago.cluster.networkclustering
+.. automodule:: etrago.cluster.electrical
     :members:
     :undoc-members:
     :show-inheritance:
 
-etrago\.cluster\.snapshot module
+etrago.cluster.gas module
+-----------------------------------------
+
+.. automodule:: etrago.cluster.gas
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.cluster.snapshot module
 --------------------------------
 
 .. automodule:: etrago.cluster.snapshot
     :members:
     :undoc-members:
     :show-inheritance:
 
-Module contents
----------------
+etrago.cluster.spatial module
+--------------------------------
 
-.. automodule:: etrago.cluster
+.. automodule:: etrago.cluster.spatial
     :members:
     :undoc-members:
     :show-inheritance:
-

doc/api/etrago.tools.rst

@@ -1,56 +1,66 @@
-etrago\.tools package
+etrago.tools package
 =====================
 
-Submodules
-----------
+etrago.tools.calc\_results module
+----------------------------------
 
-etrago\.tools\.io module
-------------------------
+.. automodule:: etrago.tools.calc_results
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. automodule:: etrago.tools.io
+etrago.tools.constraints module
+----------------------------------
+
+.. automodule:: etrago.tools.constraints
     :members:
     :undoc-members:
     :show-inheritance:
 
+etrago.tools.execute module
+----------------------------------
 
-etrago\.tools\.extendable module
-------------------------
+.. automodule:: etrago.tools.execute
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.tools.extendable module
+----------------------------------
 
 .. automodule:: etrago.tools.extendable
     :members:
     :undoc-members:
     :show-inheritance:
 
+etrago.tools.io module
+------------------------
 
-etrago\.tools\.plot module
---------------------------
-
-.. automodule:: etrago.tools.plot
+.. automodule:: etrago.tools.io
     :members:
     :undoc-members:
     :show-inheritance:
 
-etrago\.tools\.snapshot\_clustering module
-------------------------------------------
+etrago.tools.network module
+-----------------------------
 
-.. automodule:: etrago.tools.snapshot_clustering
+.. automodule:: etrago.tools.network
     :members:
     :undoc-members:
     :show-inheritance:
 
-etrago\.tools\.utilities module
--------------------------------
+etrago.tools.plot module
+---------------------------
 
-.. automodule:: etrago.tools.utilities
+.. automodule:: etrago.tools.plot
     :members:
     :undoc-members:
     :show-inheritance:
 
+etrago.tools.utilities module
+-------------------------------
 
-Module contents
----------------
-
-.. automodule:: etrago.tools
+.. automodule:: etrago.tools.utilities
     :members:
     :undoc-members:
     :show-inheritance:

doc/conf.py

@@ -122,7 +122,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:

doc/developer_notes.rst

@@ -15,7 +15,7 @@ Installation for Developers
 
 .. code-block:: bash
 
-   $ virtualenv --clear -p python3.7  etrago``
+   $ virtualenv --clear -p python3.8  etrago``
    $ cd etrago/
    $ source bin/activate
    

doc/howToUse.rst

@@ -5,15 +5,15 @@ How to use eTraGo?
 
 After you installed eTraGo you would typically start optimization runs by
 executing the ‘appl.py’ which is situated in 
-``./eTrago/etrago/`` (e.g by ``python3 appl.py``).
+``./eTrago/etrago/`` (e.g by ``python3 appl.py`` from the terminal).
 
 eTraGo doesn't have a graphical user interface, 
 the ‘appl.py’ is used as a simple user interface which can be edited with 
 the preferred python-editor.
 Here parameters, calculation methods and scenario settings are set in a python
 dictionary called 'args'. 
 To run the desired calculation, it is crucial to understand these parameters. 
-In addition, some of them contradict the usage of others. 
+In addition, some of them contradict the usage of others.
 You find the documentation of all defined parameters from the 'args' here:
 :func:`etrago.appl.run_etrago`.
 
@@ -35,7 +35,7 @@ For more specific or extensive changes you are highly invited
 to write code and add new functionalities.
 
 Once the calculation has finished the PyPSA network of the Etrago-object will
-contain all results. Som main results (e.g. anuual system costs) are calculated
+contain all results. Some main results (e.g. anuual system costs) are calculated
 by :meth:`etrago.calc_results` and can be accesed via 'etrago.results'.
 You can use several plotting functions from the :meth:`etrago.tools.plot` in order
 to visualize the results. For example 
@@ -52,7 +52,7 @@ Examples and tutorial notebooks
 
 
 
-.. toctree::
-   :maxdepth: 7
+**eTraGo version 0.5.1:**
+`etrago_OpenMod_Zuerich18 <https://github.com/openego/eGo/blob/master/ego/examples/tutorials/etrago_OpenMod_Zuerich18.ipynb>`_.
 
-   OpenMod  <https://github.com/openego/eGo/blob/master/ego/examples/tutorials/etrago_OpenMod_Zuerich18.ipynb>
+**eTraGo version 0.9:** Tutorial notebook will be available in the next release.