A web user interface for energy systems modelling | GitHub
- About
- How to install
- Quick Start
- Documentation
- Contributing
- What's new
- Citing
- License
- Remove/Uninstall
- Attribution
The HotMaps Dispatch Model is a web user interface to develop energy system models. It is based on Pyomo for modeling and bokeh for visualization and interaction. The primary focus is flexible model creation with/and without the web user interface, and a high temporal resolution (hourly based) for the optimization. It has also the ability to execute and create many scenarios.
A model can be fully defined by the web user interaface, with financal and technical details on technologies, demand,electricity,temperature and radiation profiles. You can also define and upload your own data. The Hotmaps Disptach Model takes these inputs and constructs an optimization problem, solves it, and reports back the results. The results are saved as HTML (for visualisation), JSON and EXCEL Files and can be further analyzed.
Before you continue, please install the GUROBI Solver or the free GLPK Solver
-
install miniconda
-
Download this repository and save and unzip the content into your desired loacation
-
open the conda prompt in that location and type following comands
a.
conda env create -f environment.ymlb.
conda activate hotmapsDispatchc.
python -m appfor the GUROBI solver or if you want to use the GLPK solverpython -m app --s glpk
After that your default browser should open and the web user interface will show up
To Start the tool after installation open the conda prompt and type following commands:
- activate your environment with
conda activate hotmapsDispatch - navigate to the location you unzip the tool by typing
cd path2folder(Note: Replace "path2folder" with the path of the location where you unzip the tool) - type
python -m appfor the GUROBI solver or if you want to use the GLPK solverpython -m app --s glpkAfter that your default browser should open and the web user interface will show up
Not implemented todo
See the documentation for more information on installing.
and also some example are included
The Getting Started Guide is a good place to start and to get a feeling how the model works.
Not implemented todo
Documentation is available on Read the Docs:
Not implemented todo
To contribute changes:
- Fork the project on GitHub
- Create a feature branch to work on in your fork (
git checkout -b new-feature) - Add your name to the AUTHORS file
- Commit your changes to the feature branch
- Push the branch to GitHub (
git push origin my-new-feature) - On GitHub, create a new pull request from the feature branch
See our contribution guidelines for more information -- and join us on Gitter to ask questions or discuss code.
Not implemented todo
See changes made in recent versions in the changelog.
Not implemented todo
If you use HotMaps Disptach for academic work please cite:
Autor Name. HotMaps Disptach: a web user interface for energy systems modelling. Reference. doi
Copyright 2019 HotMaps Disptach contributors:
- Michael Hartner
- Richard Büchele
- David Schmidinger
- Michael Gumhalter
- Jeton Hasani
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
open the conda prompt and enter following comand:
conda remove --name hotmapsDispatch --all
The layout and content of this document is partially based on the calliope-project.