Just another energy system modeling tool made by Institut NOWUM-Energy - FH Aachen.
This project provides a REST API for modeling an energy system. It allows you to store multiple datasets in a database and generate multiple simulations from each dataset.
Unfortunately, there is no frontend yet. Feel free to contribute! ... or use Postman instead.
Our documentation is available here.
Requirements:
Download Docker container from GitHub container registry:
# Latest release
docker pull ghcr.io/nowum/ensysmod:latest
# or latest development build (experts only)
docker pull ghcr.io/nowum/ensysmod:mainSpin up a container:
# Latest release
docker run -d -p 8080:8080 --name ensysmod ghcr.io/nowum/ensysmod:latest
# or latest development build (experts only)
docker run -d -p 8080:8080 --name ensysmod-dev ghcr.io/nowum/ensysmod:mainStart using the REST API by visiting http://localhost:8080/docs/
Requirements:
- Git
- Python 3.6+
- pip
- GUROBI or GLPK
Clone this repository:
git clone https://github.com/NOWUM/EnSysMod.git
cd EnSysModInstall requirements:
sh scripts/install.shRun the server:
sh scripts/run.shStart using the REST API by visiting http://localhost:8080/docs/
If you want to run an optimization, you need to install a solver like Gurobi or [GLPK] (https://www.gnu.org/software/glpk/glpk.html).
No user interface for now, sorry!
You might use Postman to consume the API.
A detailed documentation is available here.
Contributors are always welcome! For more information check out our Contributing Guidelines.