deflex - flexible multi-regional energy system model for heat, power and mobility¶
The following README gives you a brief overview about deflex. Read the full documentation for all information.
- Multi sectoral energy system of Germany/Europe
- Dispatch optimisation
- Start with basic scenarios
- Highly configurable and adaptable
Documentation¶
The full documentation of deflex is available on readthedocs.
Go to the download page to download different versions and formats (pdf, html, epub) of the documentation.
Installation¶
To run deflex you have to install the Python package and a solver:
- deflex is available on PyPi and can be
installed using
pip install deflex
. - an LP-solver is needed such as CBC (default), GLPK, Gurobi*, Cplex*
- for some extra functions additional packages and are needed
* Proprietary solver
Use example¶
- Run
pip install deflex[example]
- Create a local directory (e.g. /home/user/deflex_examples).
- Download the example scripts to this directory. There are two example. The model_example.py will explain the modelling process, the basic_analyses_example.py will show you how to analyse the results.
- Read the comments of each example, execute it and modify it to your needs.
Do not forget to set the
my_path
in the examples first. - In parallel you should read the
usage guide
of the documentation to get the full picture.
Improve deflex¶
We are warmly welcoming all who want to contribute to the deflex library. This includes the following actions:
- Write bug reports or comments
- Improve the documentation (including typos, grammar)
- Add features improve the code (open an issue first)
Citing deflex¶
Go to the Zenodo page of deflex to find the DOI of your version. To cite all deflex versions use:
License¶
Copyright (c) 2016-2021 Uwe Krien
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.