Installation

eGo is designed as a Python package therefore it is mandatory to have Python 3 installed. If you have a working Python3 environment, use pypi to install the latest eGo version. We highly recommend you to use a virtual environment. Use following pip command in order to install eGo:

$ pip3 install eGo --process-dependency-links

Using virtual environment

Firstly, you create a virtual environment and activate it:

$ virtualenv venv --clear -p python3.5
$ source venv/bin/activate
$ cd venv

Inside your virtual environment you can install eGo with the pip command.

Linux and Ubuntu

The package eGo is tested with Ubuntu 16.04 and 18.04 inside the virtual environments of virtualenv. The installation is shown above.

Windows or Mac OSX users

For Windows and/or Mac OSX user we highly recommend to install and use Anaconda for your Python3 installation. First install anaconda inclusing python 3.5 or higher version from https://www.anaconda.com/download/ and open an anaconda prompt as administrator and run:

$ conda install pip
$ conda config --add channels conda-forge
$ conda install shapely
$ pip3 install eGo --process-dependency-links

The full documentation can be found on this page. We use Anaconda with an own environment in order to reduce problems with packages and different versions on our system. Learn more about Anacona environments.

Setup database connection

The package ego.io gives you a python SQL-Alchemy representations of the OpenEnergy-Database (oedb) and access to it by using the oedialect a SQL-Alchemy binding Python package for the REST-API used by the OpenEnergy Platform (OEP). Your API access / login data will be saved in the folder .egoio in the file config.ini. You can create a new account on openenergy-platform.org/login.

oedialect connection

[oedb]
dialect  = oedialect
username = <username>
database = oedb
host     = openenergy-platform.org
port     = 80
password = <token>

Local database connection

[local]
username = YourOEDBUserName
database = YourLocalDatabaseName
host = localhost or 127.0.0.1
port = 5433
pw = YourLocalPassword

Old developer connection

[oedb]
username = YourOEDBUserName
database = oedb
host = oe2.iws.cs.ovgu.de
port = 5432
pw = YourOEDBPassword