Repository for the code of the Open Energy Platform (OEP) website http://openenergy-platform.org/. This repository does not contain data, for data access please consult this page

This repository is licensed under GNU Affero General Public License v3.0 (AGPL-3.0)

The installation steps have been proofed on linux and windows for python 3.6 and 3.7. Be aware that some of the required packages present installation's difficulties on windows

Clone the repository locally

git clone https://github.com/OpenEnergyPlatform/oeplatform.git oep-website

Move to the cloned repository

cd oep-website 

If you are a windows user, we recommand you use conda because of the dependency on the shapely package

1.  conda env create –n oep-website
   

2.  activate oep-website
   

3.  conda config –add channels conda-forge
   

4.  conda install shapely
   

5.  pip install –r requirements.txt
   

If you don't want to use conda, here you can find instructions for setting up virtual environment

After you have activated your virtual environment, install the required python libraries

pip install -r requirements.txt

The OEP website relies on two different databases:

1. One that is managed by django itself (django internal database) This database contains all information that is needed for the website (user management, factsheets and api token for connection to the second database).
2. The second one will contain the data that the user can access from the website (primary database)

If postgresql is not installed yet on your computer, you can follow this guide

Once logged into your psql session (for linux: sudo -u postgres psql, for windows: psql), run the following lines:

create user oep_django_user with password '<oep_django_password>';
create database oep_django with owner = oep_django_user;

In the repository, copy the file oeplatform/securitysettings.py.default and rename it oeplatform/securitysettings.py. Then, enter the connection to your above mentioned postgresql database.

Create the environment variables OEP_DJANGO_USER and OEP_DJANGO_PW with values oep_django_user and <oep_django_password>, respectively.

For default settings, you can type the following commands

• On windows We recommend you set the environment variables via menus. However, we still provide you with the terminal commands (before you can set environment variables in your terminal you should first type cmd/v).

  set OEP_DJANGO_USER=oep_django_user
  set OEP_DJANGO_PW=<oep_django_password>
  

  In the following steps we'll provide the terminal commands but you always can set the environment variables via menus instead.

• On linux

  export OEP_DJANGO_USER=oep_django_user
  export OEP_DJANGO_PW=<oep_django_password>
  

Finish the django database setup with this command

python manage.py migrate

This database is used for the data input functionality implemented in dataedit/.

If this is your first local setup of the OEP website, this database should be an empty database as it will be instantiated by automated scripts later on.

Once logged into your psql session (for linux: sudo -u postgres psql, for windows: psql), run the following lines:

create user oep_db_user with password '<oep_db_password>';
create database oep_db with owner = oep_db_user;

Then enter in oep_db (\c oep_db;) and type the additional commands:

create extension postgis;
create extension postgis_topology;
create extension hstore;

Make sure to set the required environment variables before going to the next section!

For default settings, you can type the following commands

• On windows

  set LOCAL_DB_USER=oep_db_user
  set LOCAL_DB_PASSWORD=<oep_db_password>
  set LOCAL_DB_NAME=oep_db
  

• On linux

  export LOCAL_DB_USER=oep_db_user
  export LOCAL_DB_PASSWORD=<oep_db_password>
  export LOCAL_DB_NAME=oep_db
  

Note, if you kept the default name from the above example in 2.1, then the environment variables LOCAL_DB_USER and LOCAL_DB_NAME should have the values oep_db_user and oep_db, respectively

In order to run the OEP website, the primary database needs some extra management tables. We use alembic to keep track of changes in those tables. To create all tables that are needed, simply type

python manage.py alembic upgrade head

You can run your local copy of the OEP website with

python manage.py runserver

By default, you should be able to connect to this copy by visiting localhost:8000 in your web browser.

To create a dummy user for functionality testing purposes

• On windows

  set DJANGO_SETTINGS_MODULE=oeplatform.settings
  

• On linux

  export DJANGO_SETTINGS_MODULE=oeplatform.settings
  

Then execute this python code (either directly in a terminal or from a file)

  import django
  django.setup()
  from login.models import myuser
  u = myuser.objects.create_devuser('test','test@mail.com')
  u.set_password('pass')
  u.save()

Please read carefully the CONTRIBUTING.md file before you start contributing!