Merge pull request #31 from openego/dev

Release 0.1.0

Author: WolfBunke

.gitignore

@@ -4,3 +4,8 @@ __pycache__/
 results
 *.egg-info
 ego/scenario_setting.json
+.spyproject/
+ego/noise_values.csv
+.idea/
+noise_values.csv
+

README.rst

@@ -16,14 +16,14 @@ A speciality in this context is that transmission grids are described by the 380
 Installing Developer Version
 ============================
 
-Create a virtualenvironment (where you like it) and activate it: 
+Create a virtualenvironment (where you like it) and activate it:
 
 .. code-block::
 
    $ virtualenv eGo --clear -p python3.5
    $ source venv/bin/activate
 
-   $ pip install -e git+https://github.com/openego/eGo@dev#egg=eGo
+   $ pip3 install -e git+https://github.com/openego/eGo@dev#egg=eGo --process-dependency-links --allow-all-external
 
 
 Copyleft

doc/api.rst

@@ -2,6 +2,7 @@
 
 .. toctree::
    :maxdepth: 7
+   :glob:
    :titlesonly:
 
    API <api/modules>

doc/conf.py

@@ -1,4 +1,4 @@
-"""This file is part of 
+"""This file is part of
 
 It is developed in the project open_eGo: https://openegoproject.wordpress.com
 
@@ -37,6 +37,10 @@
 #sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath('../'))
 
+
+sys.path
+
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -52,14 +56,18 @@
     'sphinx.ext.coverage',
     'sphinx.ext.imgmath' ,
     'sphinx.ext.viewcode',
-#    'sphinx.ext.autosummary',
+    'sphinx.ext.autosummary',
 #    'sphinxcontrib.napoleon',#enable Napoleon interpreter of docstrings Sphinx v<=1.2
     'sphinx.ext.napoleon', #enable Napoleon Sphinx v>1.3
 #    'sphinx_paramlinks',#to have links to the types of the parameters of the functions
      'numpydoc',
+     'sphinxcontrib.httpdomain',   # for restfull API
+     'sphinxcontrib.autohttp.flask',
      'sphinx.ext.extlinks' # enables external links with a key
 ]
 
+
+
 # Napoleon settings
 napoleon_google_docstring = True
 napoleon_numpy_docstring = True
@@ -84,8 +92,51 @@
                       'Shapely object')
 }
 
+# test oedb implementation
+def rstjinja(app, docname, source):
+    """
+    Render our pages as a jinja template for fancy templating goodness.
+    """
+    # Make sure we're outputting HTML
+    if app.builder.format != 'html':
+        return
+    src = source[0]
+    rendered = app.builder.templates.render_string(
+        src, app.config.html_context
+    )
+    source[0] = rendered
+
+def setup(app):
+    app.connect("source-read", rstjinja)
 
+import requests
 
+oep_url= 'http://oep.iks.cs.ovgu.de/'
+
+# get data from oedb test
+power_class = requests.get(oep_url+'/api/v0/schema/model_draft/tables/ego_power_class/rows/', ).json()
+
+import json
+path = os.getcwd()
+json_file ='../ego/scenario_setting.json'
+
+with open(path +'/'+json_file) as f:
+    scn_set = json.load(f)
+
+
+
+html_context = {
+    'power_class': power_class,
+    'scn_setting': scn_set
+}
+
+
+
+
+
+
+# add RestFull API
+httpexample_scheme = 'https'
 
 
 # Add any paths that contain templates here, relative to this directory.
@@ -104,7 +155,7 @@
 
 # General information about the project.
 project = u'eGo'
-copyright = u'2015-2017, open_eGo-Team'
+copyright = u'2015-2018, open_eGo-Team'
 author = u'open_eGo-Team'
 
 
@@ -113,7 +164,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.0.1'
+version = '0.1.0'
 # The full version, including alpha/beta/rc tags.
 release = '0.0.1dev'
 
@@ -175,11 +226,11 @@ def __getattr__(cls, name):
 
     MOCK_MODULES = ['ding0', 'ding0.results', 'shapely']
     sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
-    
-    MOCK_MODULES = ['libgeos', 'geos', 'libgeos_c', 'geos_c','libgeos_c.so.1', 
+
+    MOCK_MODULES = ['libgeos', 'geos', 'libgeos_c', 'geos_c','libgeos_c.so.1',
                 'libgeos_c.so', 'shapely', 'geoalchemy2', 'geoalchemy2.shape ']
 
-       
+
 
 # -- Options for HTML output ----------------------------------------------
 

doc/developer.rst

@@ -28,7 +28,7 @@ eDisGo units
 ------------
 
 .. csv-table:: List of variables and units
-   :file: https://raw.githubusercontent.com/openego/eDisGo/dev/doc/units_table.csv
+   :url: https://raw.githubusercontent.com/openego/eDisGo/dev/doc/units_table.csv
    :delim: ;
    :header-rows: 1
    :widths: 5, 1, 1, 5

doc/getting_started.rst

@@ -27,7 +27,7 @@ Installation
     ```
 
 With your activated environment `cd` to the cloned directory and run
-``pip3 install -e eGo`` . This will install all needed packages into your environment.
+``pip3 install -e eGo --process-dependency-links --allow-all-external`` . This will install all needed packages into your environment.
 
 .. warning::
 
@@ -42,14 +42,16 @@ With your activated environment `cd` to the cloned directory and run
    ``pip3 install -e git+https://github.com/openego/PyPSA.git@dev#egg=PyPSA``
    and Folium for an web based ploting with
    ``pip3 install -e git+git@github.com:python-visualization/folium.git@5739244acb9868d001032df288500a047b232857#egg=folium``
-   
-   Check if the `config.json <https://github.com/openego/eTraGo/blob/dev/etrago/tools/config.json>`_ 
+
+   Check if the `config.json <https://github.com/openego/eTraGo/blob/dev/etrago/tools/config.json>`_
    file from eTraGo is installed in your libary ``/lib/python3.5/site-packages/etrago/tools`` .
-   If not copy and paste this file into this folder. 
+   If not copy and paste this file into this folder.
+
+   If Database connection or table erros appears use: ``pip3 install -e git+git@github.com:openego/ego.io.git@3b76dfddea14d67eb4421b6223bf981d8851e4e6#egg=ego.io``
+
 
 Using eGo:
 ==========
 
 1. check and prepare your eGo setting in ``ego/scenario_setting.json``
-2. Start your calculation with in the directory of ``eGo/ego`` with
-  ``python3 ego_main.py``
+2. Start your calculation with in the directory of ``eGo/ego`` with ``python3 ego_main.py``

doc/whatsnew.rst

@@ -9,4 +9,5 @@ See what's new as per release!
     :backlinks: top
 
 
+.. include:: whatsnew/v0-1-0.rst
 .. include::  whatsnew/v0-0-1.rst

doc/whatsnew/v0-1-0.rst

@@ -0,0 +1,21 @@
+Release v0.1.0 (March 29, 2018)
++++++++++++++++++++++++++++++++
+
+As this is the second release of eGo. This Release introduce the resulte class
+and is still under construction and not ready for a normal use.
+
+
+
+
+Added features
+--------------
+
+* Update of Interface between eTraGo and eDisGo (specs)
+* New structure of eGo module / resulte class
+* Restructuring of functions
+* Add import function of eTraGo results form oedb
+
+Notes
+-----
+
+* The 'direct_specs' function is not working and needs to be set to ``false``

ego/data/ding0_grids/ding0_grids__1802.pkl

@@ -21,9 +21,10 @@
     from tools.plots import (make_all_plots,plot_line_loading, plot_stacked_gen,
                                      add_coordinates, curtailment, gen_dist,
                                      storage_distribution, igeoplot)
+    # For importing geopandas you need to install spatialindex on your system http://github.com/libspatialindex/libspatialindex/wiki/1.-Getting-Started
     from tools.utilities import get_scenario_setting, get_time_steps
     from tools.io import geolocation_buses, etrago_from_oedb
-    from tools.results import total_storage_charges
+    from tools.results import eGo
     from sqlalchemy.orm import sessionmaker
     from egoio.tools import db
     from etrago.tools.io import results_to_oedb
@@ -33,10 +34,25 @@
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
+## Logging
+logging.basicConfig(format='%(asctime)s %(message)s',level=logging.INFO)
+
+logger = logging.getLogger(__name__)
+ego_logger = logging.getLogger('ego')
+
+fh = logging.FileHandler('ego.log', mode='w')
+fh.setLevel(logging.INFO)
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+fh.setFormatter(formatter)
+
+logger.addHandler(fh)
+ego_logger.addHandler(fh)
+
 
 if __name__ == '__main__':
     # import scenario settings **args of eTraGo
     args = get_scenario_setting(json_file='scenario_setting.json')
+    print (args)
 
     try:
         conn = db.connection(section=args['global']['db'])
@@ -50,91 +66,58 @@
         # start eTraGo calculation
         eTraGo = etrago(args['eTraGo'])
 
-        #ToDo save result to db
-        # Does not work wait for eTraGo release 0.5.1
-        #results_to_oedb(session, eTraGo, args['eTraGo'], grid='hv')
+        eGo = eGo(eTraGo=eTraGo, scn_name='Status Quo')
 
         # add country code to bus and geometry (shapely)
         # eTraGo.buses = eTraGo.buses.drop(['country_code','geometry'], axis=1)
         #test = geolocation_buses(network = eTraGo, session)
 
-        # other plots based on matplotlib
-        make_all_plots(eTraGo)
         # make a line loading plot
-        plot_line_loading(eTraGo)
+        eGo.eTraGo.plot_line_loading(eTraGo)
 
-        # plot stacked sum of nominal power for each generator type and timestep
-        plot_stacked_gen(eTraGo, resolution="MW")
-
-        # plot to show extendable storages
-        storage_distribution(eTraGo)
-
-        # plot storage total charges and discharge
-        total_storage_charges(eTraGo, plot=True)
 
     # get eTraGo results form db
-    if args['global']['result_id']:
+    if args['global']['recover']:
         eTraGo = etrago_from_oedb(session,args)
 
-
     # use eTraGo results from ego calculations if true
     # ToDo make function edisgo_direct_specs()
 
-    if args['eDisGo']['direct_specs']:
-        # ToDo: add this to utilities.py
-        bus_id = 27334
-        specs_meta_data = {}
-        specs_meta_data.update({'TG Bus ID':bus_id})
 
-        # Retrieve all Data
-        ### Snapshot Range
-        #snap_idx = eTraGo_network.snapshots
 
-        ## Bus Power
-
-        try:
-            active_power_kW = eTraGo_network.buses_t.p[str(bus_id)] * 1000 # PyPSA result is in MW
-        except:
-            logger.warning('No active power series')
-            active_power_kW = None
+    if args['eDisGo']['direct_specs']:
+        # ToDo: add this to utilities.py
 
-        try:
-            reactive_power_kvar = eTraGo_network.buses_t.q[str(bus_id)] * 1000 # PyPSA result is in Mvar
-        except:
-            logger.warning('No reactive power series')
-            reactive_power_kvar = None
+        logging.info('Retrieving Specs')
 
+        bus_id = 27574 #23971
 
-        ## Gens
-        all_gens = eTraGo_network.generators.bus
-        bus_gens = all_gens.index[all_gens == str(bus_id)]
-        p_nom = eTraGo_network.generators.p_nom[bus_gens]
-        gen_type = eTraGo_network.generators.carrier[bus_gens]
+        from ego.tools.specs import get_etragospecs_direct, get_mvgrid_from_bus_id
+        from egoio.db_tables import model_draft
+        specs = get_etragospecs_direct(session, bus_id, eTraGo, args)
 
-        gen_df = pd.DataFrame({'p_nom': p_nom,'gen_type':gen_type})
-        capacity = gen_df[['p_nom','gen_type']].groupby('gen_type').sum().T
 
-        gens = eTraGo_network.generators
-        for key, value in gens.items():
-            print (key)
 
     # ToDo make loop for all bus ids
     #      make function which links bus_id (subst_id)
     if args['eDisGo']['specs']:
 
+
         logging.info('Retrieving Specs')
         # ToDo make it more generic
         # ToDo iteration of grids
         # ToDo move part as function to utilities or specs
-        bus_id = 23971
+        bus_id = 27574 #23971
         result_id = args['global']['result_id']
-        scn_name = args['global']['scn_name'] # Six is Germany for 2 Snaps with minimal residual load
 
-        from ego.tools.specs import get_etragospecs_from_db
+        from ego.tools.specs import get_etragospecs_from_db, get_mvgrid_from_bus_id
         from egoio.db_tables import model_draft
-        specs = get_etragospecs_from_db(session, bus_id, result_id, scn_name)
+        specs = get_etragospecs_from_db(session, bus_id, result_id)
+
+        mv_grid = get_mvgrid_from_bus_id(session, bus_id) # This function can be used to call the correct MV grid
 
     if args['global']['eDisGo']:
+
         logging.info('Starting eDisGo')
 
         # ToDo move part as function to utilities or specs
@@ -145,7 +128,7 @@
 
         # ToDo get ding0 grids over db
         # ToDo implemente iteration
-        file_path = '/home/dozeumbuw/ego_dev/src/ding0_grids__1802.pkl'
+        file_path = 'data/ding0_grids/ding0_grids__1802.pkl'
 
         #mv_grid = open(file_path)
 
@@ -157,7 +140,7 @@
         scenario = Scenario(etrago_specs=specs,
                     power_flow=(),
                     mv_grid_id=mv_grid_id,
-                    scenario_name= args['global']['scn_name'])
+                    scenario_name= args['eTraGo']['scn_name'])
 
         network = Network.import_from_ding0(file_path,
                                     id=mv_grid_id,
@@ -182,6 +165,7 @@
         print(costs)
 
 
+
     # make interactive plot with folium
     #logging.info('Starting interactive plot')
     #igeoplot(network=eTraGo, session=session, args=args)    # ToDo: add eDisGo results