Merge pull request #188 from openego/release/v0.6

Release/v0.6

.gitignore

@@ -1,3 +1,3 @@
 etrago/cluster/__pycache__/networkclustering.cpython-36.pyc
-eTraGo.egg-info/*
-src/*
+-eTraGo.egg-info/*
+-src/* 

README.rst

@@ -7,39 +7,50 @@ 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 distribution grid. The integration of the transmission and 'upper' distribution grid is part of eTraGo.
+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
+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
+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
 
 
-Setup 
+Setup
 =========================
 
 
-Run:
+Create a virtualenvironment (where you like it) and activate it:
 
-    ```
-    git clone https://github.com/openego/eTraGo
-    ```
+.. code-block::
 
-Create a virtualenvironment (where you like it) and activate it: 
+   $ virtualenv venv --clear -p python3.5
+   $ source venv/bin/activate
+   $ cd venv
 
-   ```
-   virtualenv -p python3 venv
-   source venv/bin/activate 
-   ```
+Clone the source code from github
 
-With your activated environment `cd` to the cloned directory and run: 
+.. code-block::
 
-    ```
-    pip install -e eTraGo
-    ```
+   $ git clone https://github.com/openego/eTraGo
 
-This will install all needed packages into your environment. Now you should be ready to go. 
+
+With your activated environment `cd` to the cloned directory and run:
+
+.. code-block::
+
+   $ pip3 install -e eTraGo --process-dependency-links
+
+
+This will install all needed packages into your environment. Now you should be
+ready to go.
 
 Copyleft
 =========================
 
 Code licensed under "GNU Affero General Public License Version 3 (AGPL-3.0)"
 It is a collaborative work with several copyright owners:
-Cite as "eTraGo" © Flensburg University of Applied Sciences, Centre for Sustainable Energy Systems © Europa-Universität Flensburg, Centre for Sustainable Energy Systems © DLR Institute for Networked Energy Systems"
+Cite as "eTraGo" © Flensburg University of Applied Sciences, Centre for
+Sustainable Energy Systems © Europa-Universität Flensburg, Centre for
+Sustainable Energy Systems © DLR Institute for Networked Energy Systems"

doc/about.rst

@@ -1,11 +1,53 @@
+============
 About 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 distribution grid. The integration of the transmission and 'upper' distribution grid is part of eTraGo.
+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
+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 and grid expansion measures.
 
-The focus of optimization are flexibility options with a special focus on energy storages and grid expansion measures.
 
+The open_eGo project
+====================
 This software project is part of the research project
 `open_eGo <https://openegoproject.wordpress.com>`_.
+
+
+The OpenEnergy Platform
+=======================
+With in this project we developted 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 see
+`openenergy-platform <https://openenergy-platform.org/>`_ and login.
+
+
+LICENSE
+=======
+
+© Copyright 2015-2018
+Flensburg University of Applied Sciences,
+Europa-Universität Flensburg,
+Centre for Sustainable Energy Systems and
+DLR-Institute for Networked Energy Systems
+
+
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option)
+any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
+more details.
+
+You should have received a copy of the GNU General Public License along
+with this program.
+If not, see `www.gnu.org/licenses <https://www.gnu.org/licenses/>`_.

doc/api/etrago.cluster.rst

@@ -1,6 +1,14 @@
 etrago\.cluster package
 =======================
 
+Module contents
+---------------
+
+.. automodule:: etrago.cluster
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 Submodules
 ----------
 
@@ -21,10 +29,3 @@ etrago\.cluster\.snapshot module
     :show-inheritance:
 
 
-Module contents
----------------
-
-.. automodule:: etrago.cluster
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/api/etrago.tools.rst

@@ -12,6 +12,16 @@ etrago\.tools\.io module
     :undoc-members:
     :show-inheritance:
 
+
+etrago\.tools\.extendable module
+------------------------
+
+.. automodule:: etrago.tools.extendable
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
 etrago\.tools\.plot module
 --------------------------
 

doc/conf.py

@@ -57,7 +57,8 @@
     'sphinx.ext.napoleon', #enable Napoleon Sphinx v>1.3
 #    'sphinx_paramlinks',#to have links to the types of the parameters of the functions
      'numpydoc',
-     'sphinx.ext.extlinks' # enables external links with a key
+     'sphinx.ext.extlinks', # enables external links with a key
+     'nbsphinx' # incluede notebooks 
 ]
 
 # Napoleon settings
@@ -103,18 +104,18 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'eTraGo - Optimization of flexibility options for transmission grids based on PyPSA'
-copyright = u'2015-2017, Flensburg University of Applied Sciences, Europa-Universität Flensburg, Centre for Sustainable Energy Systems, DLR-Institute for Networked Energy Systems'
+project = u'eTraGo'
+copyright = u'2015-2018, Flensburg University of Applied Sciences, Europa-Universität Flensburg, Centre for Sustainable Energy Systems, DLR-Institute for Networked Energy Systems'
 author = u'ulfmueller, lukasol, wolfbunke, mariusves, s3pp'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.5'
+version = '0.6'
 # The full version, including alpha/beta/rc tags.
-release = '0.5'
+release = '0.6'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/developer_notes.rst

@@ -0,0 +1,52 @@
+
+===============
+Developer notes
+===============
+
+
+Installation for Developers
+===========================
+
+The best way is to use a virtual environment. see:
+
+Step 2) Clone the source code from github
+
+.. code-block::
+
+   $ git clone https://github.com/openego/eTraGo
+   $ git checkout dev
+
+With your activated environment `cd` to the cloned directory and run:
+
+.. code-block::
+
+   $ pip3 install -e eTraGo/ --process-dependency-links
+
+This will install all needed packages into your environment.
+Now you should be ready to go.
+
+
+Windows or Mac OSX users
+************************
+
+
+
+- download and install github (https://desktop.github.com)
+
+- open GitHubDesktop and clone eTraGo from open_eGo
+
+- open an anaconda prompt as administrator and run:
+
+   ```
+   pip install -e path/to/Github/Folder/eTraGo
+   ```
+
+   ```
+   pip install pandas == 0.20.3 (version 0.21 is not working!)
+   ```
+
+- to check if everything is installed run:
+
+   ```
+   pip freeze
+   ```

doc/getting_started.rst

@@ -1,5 +1,5 @@
-Installation 
-=========================
+Installation
+============
 
 
 Run:
@@ -8,20 +8,20 @@ Run:
     git clone https://github.com/openego/eTraGo
     ```
 
-Create a virtualenvironment (where you like it) and activate it: 
+Create a virtualenvironment (where you like it) and activate it:
 
    ```
    virtualenv -p python3 venv
-   source venv/bin/activate 
+   source venv/bin/activate
    ```
 
-With your activated environment `cd` to the cloned directory and run: 
+With your activated environment `cd` to the cloned directory and run:
 
     ```
     pip install -e eTraGo
     ```
 
-This will install all needed packages into your environment. Now you should be ready to go. 
+This will install all needed packages into your environment. Now you should be ready to go.
 
 Installation for windows users
 -----------------------------------
@@ -33,29 +33,29 @@ Installation for windows users
    ```
    conda install pip
    ```
-   
+
    ```
    conda config --add channels conda-forge
    ```
-   
+
    ```
-   conda install shapely 
+   conda install shapely
    ```
-   
-- download and install github (https://desktop.github.com) 
+
+- download and install github (https://desktop.github.com)
 
 - open GitHubDesktop and clone eTraGo from open_eGo
 
 - open an anaconda prompt as administrator and run:
-   
+
    ```
    pip install -e path/to/Github/Folder/eTraGo
    ```
-   
+
    ```
    pip install pandas == 0.20.3 (version 0.21 is not working!)
    ```
-   
+
 - to check if everything is installed run:
 
    ```
@@ -69,43 +69,43 @@ For using the session maker in eTraGo you need oemof.db:
    ```
    pip install oemof.db
    ```
-   
+
    ```
-   cd C:/Users/YourUserName 
+   cd C:/Users/YourUserName
    ```
-   
+
    ```
-   md .oemof 
+   md .oemof
    ```
 
 - open the new folder .oemof and use the editor to create a file „config.ini“ and insert the following lines, when you just calculate local or on the oedb you just need this section:
 
 ::
 
  [oedb]
- 
+
  username = YourOEDBUserName
- 
+
  database = oedb
- 
+
  host = oe2.iws.cs.ovgu.de
- 
+
  port = 5432
- 
+
  pw = YourOEDBPassword
 
  [local]
- 
- username = YourLocalUserName 
- 
+
+ username = YourLocalUserName
+
  database = YourLocalDatabaseName
- 
+
  host = 127.0.0.1
- 
+
  port = 5432
- 
+
  pw = YourLocalPassword
 
 
 
-when you just calculate local or on the oedb you just need this section 
+when you just calculate local or on the oedb you just need this section