Metadata-Version: 2.1
Name: deflex
Version: 0.2.0
Summary: deflex - flexible multi-regional energy system model for heat, power and mobility
Home-page: https://github.com/reegis/deflex
Author: Uwe Krien
Author-email: krien@uni-bremen.de
License: MIT
Project-URL: Documentation, https://deflex.readthedocs.io/
Project-URL: Changelog, https://deflex.readthedocs.io/en/latest/changelog.html
Project-URL: Issue Tracker, https://github.com/reegis/deflex/issues
Description: ========
        Overview
        ========
        
        
        
        .. image:: https://travis-ci.com/reegis/deflex.svg?branch=master
            :target: https://travis-ci.com/reegis/deflex
        
        .. image:: https://coveralls.io/repos/github/reegis/deflex/badge.svg?branch=master
            :target: https://coveralls.io/github/reegis/deflex?branch=master
        
        .. image:: https://img.shields.io/lgtm/grade/python/g/reegis/deflex.svg?logo=lgtm&logoWidth=18
            :target: https://lgtm.com/projects/g/reegis/deflex/context:python
        
        .. image:: https://img.shields.io/lgtm/alerts/g/reegis/deflex.svg?logo=lgtm&logoWidth=18
            :target: https://lgtm.com/projects/g/reegis/deflex/alerts/
        
        .. image:: https://img.shields.io/badge/automatic%20code%20style-black-blueviolet
            :target: https://black.readthedocs.io/en/stable/
        
        .. image:: https://img.shields.io/badge/licence-MIT-blue
            :target: https://spdx.org/licenses/MIT.html
        
        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3572594.svg
           :target: https://doi.org/10.5281/zenodo.3572594
        
        deflex - flexible multi-regional energy system model forheat, power and mobility
        
        * Free software: MIT license
        
        .. warning::
        
            deflex is currently under revision. If you are planning to use deflex in
            the future you should install the upcoming version (see below)!
        
        Installation
        ============
        
        We will publish a stable version soon. Until then we recommend to install the already working beta version::
        
            pip install https://github.com/reegis/deflex/archive/revise_deflex.zip
        
        
        Use the latest stable (PhD) version of deflex to run older scenarios::
        
            pip install https://github.com/reegis/deflex/archive/phd.zip
        
        
        Additional requirements
        -----------------------
        
        The basic installation can be used to compute scenarios (csv, xls, xlsx). For
        some functions additional packages are needed.
        
        1. To run the example with all plots you need the following packages:
            * pygeos (spatial operations)
            * geopandas (maps)
            * descartes (plot maps with matplotlib)
            * lmfit (linear fit)
            * matplotlib (plotting)
            * requests (download example files)
        
            ``pip install deflex[example]``
        
        2. To use the maps of the polygons, transmission lines etc.:
            * pygeos (spatial operations)
            * geopandas (maps)
        
            ``pip install deflex[map]``
        
        3. To develop deflex:
            * pytest
            * sphinx
            * sphinx_rtd_theme
            * pygeos
            * geopandas
            * requests
        
            ``pip install deflex[dev]``
        
        
        Basic usage
        ===========
        
        .. code-block:: python
        
            scenario = "/path/to/my/scenario.xls"
            main.model_scenario(scenario)
        
        
        Use example
        ===========
        
        1. Create a local directory (e.g. /home/user/my_example).
        2. Download the
           `example <https://raw.githubusercontent.com/reegis/deflex/master/examples/examples.py>`_
           to this new directory.
        3. Now execute the example file. The script will download some example
           scenarios with results and show some exemplary plots.
        4. A directory "deflex_examples" will be created in you home directory. Use
           ``print(os.path.expanduser("~"))`` to find out where your home directory is
           located. If you want to change it replace the base path in the example:
        
        .. code-block:: diff
        
            - BASEPATH = os.path.join(os.path.expanduser("~"), "deflex_examples")
            + BASEPATH = "/your/favoured/path/"
        
        Documentation
        =============
        
        
        https://deflex.readthedocs.io/
        
        The `documentation of deflex <https://deflex.readthedocs.io/en/latest/>`_ is powered by readthedocs.
        
        Go to the `download page <http://readthedocs.org/projects/deflex/downloads/>`_ to download different versions and formats (pdf, html, epub) of the documentation.
        
        
        
        Contributing
        ==============
        
        We are warmly welcoming all who want to contribute to the deflex library.
        
        
        Citing deflex
        ========================
        
        Go to the `Zenodo page of deflex <https://doi.org/10.5281/zenodo.3572594>`_ to find the DOI of your version. To cite all deflex versions use:
        
        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3572594.svg
           :target: https://doi.org/10.5281/zenodo.3572594
        
        Development
        ===========
        
        To run all the tests run::
        
            tox
        
        Note, to combine the coverage data from all the tox environments run:
        
        .. list-table::
            :widths: 10 90
            :stub-columns: 1
        
            - - Windows
              - ::
        
                    set PYTEST_ADDOPTS=--cov-append
                    tox
        
            - - Other
              - ::
        
                    PYTEST_ADDOPTS=--cov-append tox
        
        
        Changelog
        =========
        
        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
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: dev
Provides-Extra: plot
Provides-Extra: geo
Provides-Extra: example
Provides-Extra: dummy
