deflex 0.1.0rc1

A multi-sectoral model of Germany with flexible multi regions.

Introduction

The deflex library provides a simple heat and power model of Germany. Some basic scenarios with all data are included.

Documentation

The documentation of deflex is powered by readthedocs.

Go to the download page to download different versions and formats (pdf, html, epub) of the documentation.

Installation

On a Linux Debian system you can use the following command to solve all requirements beforehand.

sudo apt-get install python3-dev proj-bin libproj-dev libgeos-dev python3-tk libspatialindex-dev virtualenv

If you have a working Python 3 environment, use pypi to install the latest deflex version:

pip install deflex

The deflex library is designed for Python 3 and tested on Python >= 3.6. We highly recommend to use virtual environments. Please see the installation page of the oemof documentation for complete instructions on how to install python and a virtual environment on your operating system.

Basic usage

Create a basic scenario as xls-file or collection of csv-files using the following lines.

Note

The first run of the following lines may take some hours, because all needed data will be downloaded, processed and stored locally. On the next run the stored files will be used.

Use the logger to see the state of the script.

import logging
from deflex import basic_scenario
logging.getLogger()
logger.setLevel(logging.INFO)
basic_scenario.create_basic_scenario(2014, 'de21')

Use the following lines to optimise an existing basic scenario:

import logging
from deflex import main
logging.getLogger()
logger.setLevel(logging.INFO)
main.main(2014, 'de21')

To optimise a user scenario one has to pass the path to the scenario file(s).

import logging
from deflex import main
logging.getLogger()
logger.setLevel(logging.INFO)
main.model_scenario(xls_file='/my/path/to/scenario.xls',
                    name='my_scenario', rmap='deXX', year=2025)

It is faster to use csv-files!

import logging
from deflex import main
logging.getLogger()
logger.setLevel(logging.INFO)
main.model_scenario(csv_path='/my/path/to/my_csv_files',
                    name='my_scenario', rmap='deXX', year=2025)

Contributing

We are warmly welcoming all who want to contribute to the deflex library.

Citing deflex

Use Zenodo to get the DOI for your deflex version.

License

Copyright (c) 2019 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.