Skip to main content

deflex - flexible multi-regional energy system model for heat, power and mobility

Project description

https://raw.githubusercontent.com/reegis/deflex/master/docs/images/logo_deflex_big.svg

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 full documentation for all information.

<nav class="contents local" id="contents"> </nav>

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

  1. Run pip install deflex[example]

  2. Create a local directory (e.g. /home/user/deflex_examples).

  3. 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.

  4. 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.

  5. 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:

https://zenodo.org/badge/DOI/10.5281/zenodo.3572594.svg

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.

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.

Changelog

0.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 changed

  • Attributes und function names for adapted.

  • Documentation now covers all parts of the package

  • Examples and illustrative images were added

  • Code were cleaned up

  • Tests are more stable, test coverage increased slightly

  • Example data (v03) can be downloaded from the deflex OSF page.

Authors

  • Uwe Krien

  • Pedro Duran

0.2.0 (2021-01-25)

  • Move basic scenario with reegis dependency to new package

  • Revise structure

  • Add tox tests: pyflake, docs, coverage, tests, link-test, manifest, isort

Authors

  • Uwe Krien

Project details


Download files

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

Source Distribution

deflex-0.3.0.tar.gz (17.7 MB view hashes)

Uploaded source

Built Distribution

deflex-0.3.0-py2.py3-none-any.whl (13.1 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page