Skip to main content

A web user interface for energy system modelling

Project description


HotMaps Dispatch Model

A web user interface for energy systems modelling | GitHub


Content


About

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 visialisation), JSON and EXCEL Files and can be further analyzed.

How to install

How to install 1 (easy)

  1. install miniconda

  2. open the conda prompt and type following comands

    a. conda create -n hotmapsDispatch python=3.6

    b. conda activate hotmapsDispatch

    c. conda install nodejs

    c. pip install hotmapsDispatch

    d. hotmapsDispatch_console

After that your default browser should open and the web user interface will show up

How to install 2 (advanced)

  1. install miniconda

  2. Download this repository and save and unzip the content into your desired loacation

  3. open the conda prompt in that location and type following comands

    a. conda env create -f environment.yml

    b. conda activate hotmapsDispatch

    c. cd app/modules/common/FEAT/F16

    d. python F16_server.py

After that your default browser should open and the web user interface will show up

Hot to install 3 (easy)

Not implemented todo

The Hotmaps Dispatch Model can run on Windows, macOS and Linux.

Installing it is quickest with the conda package manager by running a single command: conda create -c conda-forge -n python=3.6 hotmapsDispatch

Quick start

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.

After installation open the conda prompt and activate your environment conda activate hotmapsDispatch

Then you can start the application by typing hotmapsDispatch_console. This will open your default browser and also show you progress messages in the prompt

If you type only hotmapsDispatch no prompt messages will be shown and you have to close the process after fininshing, since closing the tab will not shut down the process

Documentation

Not implemented todo

Documentation is available on Read the Docs:

Contributing

Not implemented todo

To contribute changes:

  1. Fork the project on GitHub
  2. Create a feature branch to work on in your fork (git checkout -b new-feature)
  3. Add your name to the AUTHORS file
  4. Commit your changes to the feature branch
  5. Push the branch to GitHub (git push origin my-new-feature)
  6. 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.

What's new

Not implemented todo

See changes made in recent versions in the changelog.

Citing

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

License

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.

Remove/Uninstall

open the conda prompt and enter following comand:

conda remove --name hotmapsDispatch --all

Attribution

The layout and content of this document is partially based on the calliope-project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hotmapsDispatch, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size hotmapsDispatch-0.0.1-py3-none-any.whl (49.8 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size hotmapsDispatch-0.0.1.tar.gz (89.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page