django-oemof 0.18.2

Django application to run oemof

Django-Oemof

Django-Oemof is a Django app to provide an API to build and optimize oemof.solph models and deliver results via JSON response.

Requirements

• oemof.tabular has to be installed
• CBC solver has to be installed. Install it via (conda):

conda install -c conda-forge coincbc

Django project must use celery and automatically detect celery tasks. (follow https://docs.celeryq.dev/en/stable/django/first-steps-with-django.html to setup celery)

Quick start

1. Add "oemof" to your INSTALLED_APPS setting like this::

       INSTALLED_APPS = [
           ...
           'rest_framework'
           'django_oemof',
       ]
   

2. Include the oemof URLconf in your project urls.py like this::

   path('oemof/', include('django_oemof.urls')),

3. Run python manage.py migrate to create the oemof models.

Configuration

You can set following configs via environment:

• DJANGO_OEMOF_IGNORE_SIMULATION_PARAMETERS list of parameter keys which shall be ignored when initializing a simulation

OEMOF Datapackages

Have to be put in folder oemof within djangos MEDIA_ROOT folder. Name of datapackage folder is used in request for building ES.

Hooks

Hooks can be used to change default behaviour of parameter setup, energysystem build and model solving. This is done by defining custom functions which can be registered in django_oemof and are applied when simulating an ES. Depending on hook type (Parameter/Energysystem/Model), the defined custom functions are applied to parameters, build Es or after creating the model. See following flow chart for order of hooks:

Every hook is scenario-dependent to allow different hooks per scenario, but you can use hooks.ALL_SCENARIO as scenario to aplly hook to all scenarios. An example hook (changing default behaviour of parameter setup) could be set up as follows:

from django_oemof import hooks


def converting_demand_to_kW(data):
   data["demand"] = data["demand"] * 1000
   return data


demand_kW_hook = hooks.Hook(scenario="dispatch", function=converting_demand_to_kW)
hooks.register_hook(hooks.HookType.PARAMETER, demand_kW_hook)

Tests

Run tests for standalone app via python runtests.py