======== Overview

.. start-badges

.. list-table:: :stub-columns: 1

* - docs
  - |docs|
* - tests
  - | |tox-pytest| |tox-checks| |coveralls|
* - package
  - | |version| |wheel| |supported-versions| |supported-implementations| |commits-since| |packaging|

.. |tox-pytest| image:: https://github.com/oemof/demandlib/workflows/tox%20pytests/badge.svg?branch=dev :target: https://github.com/oemof/demandlib/actions?query=workflow%3A%22tox+checks%22

.. |tox-checks| image:: https://github.com/oemof/demandlib/workflows/tox%20checks/badge.svg?branch=dev :target: https://github.com/oemof/demandlib/actions?query=workflow%3A%22tox+checks%22

.. |packaging| image:: https://github.com/oemof/demandlib/workflows/packaging/badge.svg?branch=dev :target: https://github.com/oemof/demandlib/actions?query=workflow%3Apackaging

.. |docs| image:: https://readthedocs.org/projects/demandlib/badge/?style=flat :target: https://demandlib.readthedocs.io/ :alt: Documentation Status

.. |coveralls| image:: https://coveralls.io/repos/oemof/demandlib/badge.svg?branch=dev&service=github :alt: Coverage Status :target: https://coveralls.io/github/oemof/demandlib?branch=dev

.. |version| image:: https://img.shields.io/pypi/v/demandlib.svg :alt: PyPI Package latest release :target: https://pypi.org/project/demandlib

.. |wheel| image:: https://img.shields.io/pypi/wheel/demandlib.svg :alt: PyPI Wheel :target: https://pypi.org/project/demandlib

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/demandlib.svg :alt: Supported versions :target: https://pypi.org/project/demandlib

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/demandlib.svg :alt: Supported implementations :target: https://pypi.org/project/demandlib

.. |commits-since| image:: https://img.shields.io/github/commits-since/oemof/demandlib/v0.1.8.svg :alt: Commits since latest release :target: https://github.com/oemof/demandlib/compare/v0.1.9...dev

.. end-badges

Creating heat and power demand profiles from annual values.

• Free software: MIT license

Installation

::

pip install demandlib

You can also install the in-development version with::

pip install https://github.com/oemof/demandlib/archive/master.zip

Documentation

https://demandlib.readthedocs.io/

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