This is a modified version of the open_plan user interface to map the components from oemof.solph directly to the user interface.
Learn more about the original open_plan project on their website.
This code is based from previous open-source work done building a user interface to the multi-vector-simulator tool in the Horizon2020 ELAND project. In open_plan project's scope a new design and more features are added, based on feedback collected in workshops held with stakeholders.
This repository contains the code for the user interface. The simulations are performed by inretensys-fastapi on a dedicated server (see the linked github repository). Once a simulation is over the results are stored locally on the simulation server and the user interface can access these files to create an result report. Also is it possible to download these files to create own, specific plots and reports.
Prior to be able to develop locally, you might need to install postgres, simply google install postgres followed by your os name (linux/mac/windows)
- Create a virtual environment
- Activate your virtual environment
- Install the dependencies with
pip install -r app/requirements/postgres.txt - Install extra local development dependencies with
pip install -r app/dev_requirements.txt - Move to the
appfolder withcd app - Create environment variables (only replace content surrounded by
<>)
SQL_ENGINE=django.db.backends.postgresql
SQL_DATABASE=<your db name>
SQL_USER=<your user name>
SQL_PASSWORD=<your password>
SQL_HOST=localhost
SQL_PORT=5432
DEBUG=(True|False)
- Execute the
local_setup.shfile (. local_setup.shon linux/macbash local_setup.shon windows) you might have to make it executable first. Answer yes to the question - Start the local server with
python manage.py runserver - You can then login with
testUserandASas12,.or create your own account
You need to be able to run docker-compose inside your terminal. If you can't you should install Docker desktop first.
After this step you can follow the instructions under inretensys-common. This repository contains all modules which you need to run postgres, gui and api.
You can access a preconfigured project using the following login credentials: testUser:ASas12,.