Package: deflex
deflex - flexible multi-regional energy system model for heat, power and mobility++++++ multi sectoral energy system of Germany/Europe ++++++ dispatch
optimisation ++++++ highly configurable and adaptable ++++++ multiple analyses
functions +++++The following README gives you a brief overview about deflex. Read the fulldocumentationfor all
information.InstallationUse exampleImprove deflexCiting deflexGalleryDocumentationLicense0.3.0 (2021-03-25)0.2.0 (2021-01-25)InstallationTo rundeflexyou have to install the Python package and a solver:deflex is available onPyPiand can be
installed usingpip install deflex.an LP-solver is needed such as CBC (default), GLPK, Gurobi*, Cplex*for some extra functions additional packages and are needed* Proprietary solverUse exampleRunpip install deflex[example]Create a local directory (e.g. /home/user/deflex_examples).Download the example scripts to this directory. There are two example. Themodel_example.pywill explain the modelling process, thebasic_analyses_example.pywill 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 themy_pathin the examples first.In parallel you should read theusage guideof the documentation to get
the full picture.Improve deflexWe are warmly welcoming all who want to contribute to the deflex library. This
includes the following actions:Write bug reports or commentsImprove the documentation (including typos, grammar)Add features improve the code (open an issue first)Citing deflexGo to theZenodo page of deflexto find the DOI of your version. To cite all deflex versions use:GalleryThe following figures will give you a brief impression about deflex.Figure 1:Use one of the include regions sets or create your own one. You
can also include other European countries.Figure 2:The input data can be organised in spreadsheets or csv files.Figure 3:The resulting system costs of deflex have been compared with the
day-ahead prices from the Entso-e downloaded fromOpen Power System Data. The plot shows three different periods
of the year.Figure 4:It is also possible to get a time series of the average emissions. Furthermore,
it shows the emissions of the most expensive power plant which would be
replaced by an additional feed-in.Figure 5:The following plot shows fraction of the time on which the utilisation of the
power lines between the regions is more than 90% of its maximum capacity:DocumentationThefull documentation of deflexis available on readthedocs.Go to thedownload pageto download different versions and formats (pdf, html, epub) of the
documentation.LicenseCopyright (c) 2016-2021 Uwe KrienPermission 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.Changelog0.3.0 (2021-03-25)There are many API changes in the v0.3.0 release but it is planned to keep the
API more stable from now on.Layout of input data changedAttributes und function names for adapted.Documentation now covers all parts of the packageExamples and illustrative images were addedCode were cleaned upTests are more stable, test coverage increased slightlyExample data (v03) can be downloaded from thedeflex OSF page.AuthorsUwe KrienPedro Duran0.2.0 (2021-01-25)Move basic scenario with reegis dependency to new packageRevise structureAdd tox tests: pyflake, docs, coverage, tests, link-test, manifest, isortAuthorsUwe Krien