Merge pull request #161 from openego/dev

Release 0.0.10

Author: AnyaHe

.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.6
+  install:
+    - requirements: rtd_requirements.txt

doc/conf.py

@@ -106,7 +106,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.0.9'
+version = '0.0.10'
 # The full version, including alpha/beta/rc tags.
 release = version
 

doc/config

@@ -13,7 +13,7 @@ config_db_tables
 The config file ``config_db_tables.cfg`` holds data about which database connection
 to use from your saved database connections and which dataprocessing version.
 
-.. include:: config/config_db_tables_default.cfg
+.. include:: ../edisgo/config/config_db_tables_default.cfg
    :literal:
 
 .. _config_grid_expansion:
@@ -25,7 +25,7 @@ The config file ``config_grid_expansion.cfg`` holds data mainly needed to determ
 grid expansion needs and costs - these are standard equipment to use in grid expansion and
 its costs, as well as allowed voltage deviations and line load factors.
 
-.. include:: config/config_grid_expansion_default.cfg
+.. include:: ../edisgo/config/config_grid_expansion_default.cfg
    :literal:
 
 .. _config_timeseries:
@@ -39,16 +39,16 @@ used in conventional grid expansion planning, power factors and modes (inductive
 or capacitative) to generate reactive power time series, as well as configurations
 of the demandlib in case load time series are generated using the oemof demandlib.
 
-.. include:: config/config_timeseries_default.cfg
+.. include:: ../edisgo/config/config_timeseries_default.cfg
    :literal:
 
 .. _config_grid:
 
 config_grid
 ----------------------
 
-The config file ``config_grid.cfg`` holds data to specify parameters used when 
+The config file ``config_grid.cfg`` holds data to specify parameters used when
 connecting new generators to the grid and where to position disconnecting points.
 
-.. include:: config/config_grid_default.cfg
+.. include:: ../edisgo/config/config_grid_default.cfg
    :literal:

doc/configs.rst

@@ -8,44 +8,44 @@ The following tables hold all data of cables, lines and transformers used.
 .. _lv_cables_table:
 
 .. csv-table:: LV cables
-   :file: equipment/equipment-parameters_LV_cables.csv
+   :file: ../edisgo/equipment/equipment-parameters_LV_cables.csv
    :delim: ,
    :header-rows: 2
-   :widths: 5, 1, 1, 1, 1, 1, 5
+   :widths: 3, 1, 1, 1, 1
    :stub-columns: 0
 
 .. _mv_cables_table:
 
 .. csv-table:: MV cables
-   :file: equipment/equipment-parameters_MV_cables.csv
+   :file: ../edisgo/equipment/equipment-parameters_MV_cables.csv
    :delim: ,
    :header-rows: 2
-   :widths: 5, 1, 1, 1, 1, 1
+   :widths: 4, 1, 1, 1, 1, 1
    :stub-columns: 0
 
 .. _mv_lines_table:
 
 .. csv-table:: MV overhead lines
-   :file: equipment/equipment-parameters_MV_overhead_lines.csv
+   :file: ../edisgo/equipment/equipment-parameters_MV_overhead_lines.csv
    :delim: ,
    :header-rows: 2
-   :widths: 5, 1, 1, 1, 1, 1
+   :widths: 4, 1, 1, 1, 1, 1
    :stub-columns: 0
 
 .. _lv_transformers_table:
 
 .. csv-table:: LV transformers
-   :file: equipment/equipment-parameters_LV_transformers.csv
+   :file: ../edisgo/equipment/equipment-parameters_LV_transformers.csv
    :delim: ,
    :header-rows: 2
-   :widths: 5, 1, 1, 1, 1
+   :widths: 5, 1, 1, 1
    :stub-columns: 0
 
 .. _mv_transformers_table:
 
 .. csv-table:: MV transformers
-   :file: equipment/equipment-parameters_MV_transformers.csv
+   :file: ../edisgo/equipment/equipment-parameters_MV_transformers.csv
    :delim: ,
    :header-rows: 2
-   :widths: 5, 1, 1, 1
+   :widths: 5, 1
    :stub-columns: 0

doc/equipment

@@ -30,7 +30,13 @@ The order grid expansion measures are conducted is as follows:
 
 Reinforcement of stations and lines due to overloading issues is performed twice, once in the beginning and again after fixing voltage issues,
 as the changed power flows after reinforcing the grid may lead to new overloading issues. How voltage and overloading issues are identified and
-solved is explained in the following sections.
+solved is shown in figure :ref:`grid_expansion_measures_fig` and further explained in the following sections.
+
+.. _grid_expansion_measures_fig:
+.. figure:: images/grid_expansion_measures.png
+   :scale: 50%
+
+   Grid expansion measures
 
 :py:func:`~edisgo.flex_opt.reinforce_grid.reinforce_grid` offers a few additional options. It is e.g. possible to conduct grid 
 reinforcement measures on a copy
@@ -40,6 +46,7 @@ allowed voltage deviation limits for MV and LV.
 See documentation of :py:func:`~edisgo.flex_opt.reinforce_grid.reinforce_grid` for more information. 
 
 
+
 Identification of overloading and voltage issues
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

doc/equipment.rst

@@ -28,27 +28,6 @@ is the only supported data source. You can retrieve data from `Zenodo <https://z
 (make sure you choose latest data) or check
 out the ding0 documentation on how to generate grids yourself.
 
-Aside from grid topology data you may eventually need a dataset on future installation of power plants. You
-may therefore use the scenarios developed in the `open_eGo <https://openegoproject.wordpress.com>`_ that
-are available in `OpenEnergy DataBase (oedb) <https://openenergy-platform.org/dataedit/>`_ hosted on the `OpenEnergy Platform (OEP) <https://oep.iks.cs.ovgu.de/>`_. 
-eDisGo provides an interface to the oedb using the package `ego.io <https://github.com/openego/ego.io>`_. ego.io gives you a python SQL-Alchemy representations of
-the oedb and access to it by using the `oedialect <https://github.com/openego/oedialect>`_, an SQL-Alchemy dialect used by the OEP. 
-
-To retrieve data from the oedb you need to create an account `here <http://openenergy-platform.org/login/>`_.
-Upon retrieving data with eDisGo from the oedb for the first time you will be asked to type in your login information.
-If you wish so, your login data will be saved to the folder ``.egoio`` to the file
-``config.ini`` and your password stored in a keyring, so that you don't need to type it in every time you retrieve data. 
-The ``config.ini`` holds the following information:
-
-.. code-block:: bash
-
-  [oedb]
-  dialect  = oedialect
-  username = <username>
-  database = oedb
-  host     = openenergy-platform.org
-  port     = 80
-
 .. _edisgo-mwe:
 
 A minimum working example
@@ -57,6 +36,13 @@ A minimum working example
 Following you find short examples on how to use eDisGo. Further examples and details are provided in :ref:`usage-details`.
 
 All following examples assume you have a ding0 grid topology file named "ding0_grids__42.pkl" in current working directory.
+
+Aside from grid topology data you may eventually need a dataset on future installation of power plants. You
+may therefore use the scenarios developed in the `open_eGo <https://openegoproject.wordpress.com>`_ project that
+are available in the `OpenEnergy DataBase (oedb) <https://openenergy-platform.org/dataedit/>`_ hosted on the `OpenEnergy Platform (OEP) <https://oep.iks.cs.ovgu.de/>`_.
+eDisGo provides an interface to the oedb using the package `ego.io <https://github.com/openego/ego.io>`_. ego.io gives you a python SQL-Alchemy representations of
+the oedb and access to it by using the `oedialect <https://github.com/openego/oedialect>`_, an SQL-Alchemy dialect used by the OEP.
+
 You can run a worst-case scenario as follows:
 
 Using package included command-line script
@@ -77,7 +63,7 @@ Or coding the script yourself with finer control of details
     edisgo = EDisGo(ding0_grid="ding0_grids__42.pkl",
                     worst_case_analysis='worst-case')
 
-    # Import future generators (OEP account needed!)
+    # Import scenario for future generators from the oedb
     edisgo.import_generators(generator_scenario='nep2035')
 
     # Conduct grid analysis (non-linear power flow)
@@ -119,16 +105,16 @@ Instead of conducting a worst-case analysis you can also provide specific time s
 		      'other': [1] * len(timeindex)},
 		     index=timeindex)
 
+    # Set up the EDisGo object with your own time series and generator scenario
+    # NEP2035
     edisgo = EDisGo(
         ding0_grid="ding0_grids__42.pkl",
+        generator_scenario='nep2035',
         timeseries_load=timeseries_load,
         timeseries_generation_fluctuating=timeseries_generation_fluctuating,
         timeseries_generation_dispatchable=timeseries_generation_dispatchable,
         timeindex=timeindex)
 
-    # Import future generators for NEP2035 scenario
-    edisgo.import_generators(generator_scenario='nep2035')
-
     # Do grid reinforcement
     edisgo.reinforce()
 
@@ -152,14 +138,12 @@ using the provided API for the oemof demandlib and the OpenEnergy DataBase:
 		     index=timeindex)
     edisgo = EDisGo(
         ding0_grid="ding0_grids__42.pkl",
+        generator_scenario='ego100',
         timeseries_load='demandlib',
         timeseries_generation_fluctuating='oedb',
         timeseries_generation_dispatchable=timeseries_generation_dispatchable,
         timeindex=timeindex)
 
-    # Import future generators for ego100 scenario
-    edisgo.import_generators(generator_scenario='ego100')
-
     # Do grid reinforcement
     edisgo.reinforce()
 

doc/features_in_detail.rst

@@ -0,0 +1,15 @@
+Release v0.0.10
+================
+
+Release date: <month> <day>, <year>
+
+Changes
+-------
+* Updated to networkx 2.0
+* Changed data of transformers `#240 <https://github.com/openego/ding0/issues/240>`_
+* Proper session handling and readonly usage (PR `#160 <https://github.com/openego/eDisGo/pull/160>`_)
+
+Bug fixes
+----------
+* Corrected calculation of current from pypsa power flow results (PR `#153 <https://github.com/openego/eDisGo/pull/153>`_).
+