oemof.demand 0.2.3a1__tar.gz

oemof_demand-0.2.3a1/.coveragerc

@@ -0,0 +1,14 @@
+[paths]
+source = src
+
+[run]
+branch = true
+source =
+    src
+    tests
+parallel = true
+
+[report]
+show_missing = true
+precision = 2
+omit = *migrations*

oemof_demand-0.2.3a1/.editorconfig

@@ -0,0 +1,20 @@
+# see https://editorconfig.org/
+root = true
+
+[*]
+# Use Unix-style newlines for most files (except Windows files, see below).
+end_of_line = lf
+trim_trailing_whitespace = true
+indent_style = space
+insert_final_newline = true
+indent_size = 4
+charset = utf-8
+
+[*.{bat,cmd,ps1}]
+end_of_line = crlf
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.tsv]
+indent_style = tab

oemof_demand-0.2.3a1/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# To install the git pre-commit hooks run:
+#   pre-commit install --install-hooks
+# To update the versions:
+#   pre-commit autoupdate
+exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg)(/|$)'
+# Note the order is intentional to avoid multiple passes of the hooks
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.10
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes]
+      - id: ruff-format
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
+    hooks:
+      - id: taplo-format
+      - id: taplo-lint
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: debug-statements

oemof_demand-0.2.3a1/.readthedocs.yml

@@ -0,0 +1,14 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+sphinx:
+  configuration: docs/conf.py
+formats: all
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

oemof_demand-0.2.3a1/AUTHORS.rst

@@ -0,0 +1,20 @@
+
+Authors
+=======
+
+(alphabetic order)
+
+* Amedeo Ceruti
+* Benjamin Singh
+* Birgit Schachler
+* Caroline Möller
+* Florian Maurer
+* Francesco Witte
+* Guido Plessmann
+* Hendrik Huyskens
+* Jann Launer
+* Patrik Schönfeldt
+* Pyosch
+* Steffen Wehkamp
+* Stephen Bosch
+* Uwe Krien

oemof_demand-0.2.3a1/CHANGELOG.rst

@@ -0,0 +1,166 @@
+Changelog
+=========
+
+v0.2.3 (YYYY-MM-DD)
++++++++++++++++++++++++++
+
+New features
+############
+
+Bug fixes
+#########
+*   Implement default temperature limits for VDI 4655 calculation to make
+    ``summer_temperature_limit`` and ``winter_temperature_limit`` optional
+*   Fix leap year handling in VDI 4655 profiles
+
+Other changes
+#############
+
+* Documentation improvements.
+
+
+v0.2.2 (2025-04-09)
++++++++++++++++++++++++++
+
+*   Added Electricity standard load profiles as released by the BDEW in 2025.
+*   Added VDI profile based on LPagg
+
+
+v0.2.1 (2024-08-06)
++++++++++++++++++++++++++
+
+New features
+############
+*   Allow to have holidays in industrial profile
+
+Bug fixes
+#########
+*   simple_profile from IndustrialLoadProfile behaved differently in version
+    0.2.0 compared to 0.1.9 due to pandas masking functions. We are now back
+    to the old (design) values.
+
+
+v0.2.0 (2024-06-27)
++++++++++++++++++++++++++
+
+Bug fixes
+#########
+*   Raise error for non supported shlp_type
+	in non-commercial buildings
+
+Other changes
+#############
+*   Adhere to packaging standards
+* 	Raise errors in sigmoid parameter queries
+
+
+v0.1.9 (2023-03-18)
++++++++++++++++++++++++++
+
+*   Calculation of BDEW profiles was improved
+
+
+
+v0.1.8 (2021-01-27)
++++++++++++++++++++++++++
+
+Bug fixes
+#########
+*   FutureWarning for "dyn_function_h0" was raised instead of printed
+
+
+
+v0.1.7 (2021-01-27)
++++++++++++++++++++++++++
+
+New features
+############
+*   Add dynamic h0 profile calculation
+    (The implementation is not optimised for performance.
+    Thus, it is not used by default.)
+
+Bug fixes
+#########
+*   Fix improper use of pandas.dataframe.merge
+    (oemof-demand will now work with pandas>=1.2)
+
+Other changes
+#############
+*   Update deprecated pd.datetime to datetime.datetime
+*   Add (integration) tests and coverage as CI
+*   Split BDEW profile generation into submodules
+
+
+
+v0.1.6 (2019-01-30)
++++++++++++++++++++++++++
+
+General
+#######
+
+* Update requirements
+* Fix typos
+
+
+
+v0.1.5 (2018-09-05)
++++++++++++++++++++++++++
+
+New features
+############
+
+* Add function `get_normalized_bdew_profile(self)` to get a normalised profile. You could also use an annual_demand of one to get the same results.
+
+Bug fixes
+#########
+
+* Fix y-label of the heat example plot.
+
+Other changes
+#############
+
+* Make matplotlib optional in examples.
+
+
+
+v0.1.4 (2018-05-30)
++++++++++++++++++++++++++
+
+Code
+####
+
+ * fix temperature bug
+ * fix Code style
+
+Documentation
+#############
+
+ * Documentation improvements.
+
+
+
+v0.1.1 (2016-11-30)
++++++++++++++++++++++++++
+
+New features
+############
+* Examples callable by command-line script
+
+Bug fixes
+#########
+* Path specs when installed via pip
+
+Other changes
+#############
+* Fix versioning
+
+
+
+0.1.0 (2016-10-04)
++++++++++++++++++++++++++
+
+New features
+############
+* Implementation of BDEW synthetic load profiles
+* Synthetic load profiles for heating sector
+* Self-made industry demand profile similar to BDEW profiles

oemof_demand-0.2.3a1/CONTRIBUTING.rst

@@ -0,0 +1,87 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Bug reports
+===========
+
+When `reporting a bug <https://github.com/oemof/oemof-demand/issues>`_ please include:
+
+    * Your operating system name and version.
+    * Any details about your local setup that might be helpful in troubleshooting.
+    * Detailed steps to reproduce the bug.
+
+Documentation improvements
+==========================
+
+oemof could always use more documentation, whether as part of the
+official oemof docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at https://github.com/oemof/oemof-demand/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
+
+Development
+===========
+
+To set up `oemof-demand` for local development:
+
+1. Fork `oemof-demand <https://github.com/oemof/oemof-demand>`_
+   (look for the "Fork" button).
+2. Clone your fork locally::
+
+    git clone git@github.com:YOURGITHUBNAME/oemof-demand.git
+
+3. Create a branch for local development::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+4. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/>`_ one command::
+
+    tox
+
+5. Commit your changes and push your branch to GitHub::
+
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code just make the pull request.
+
+For merging, you should:
+
+1. Include passing tests (run ``tox``).
+2. Update documentation when there's new API, functionality etc.
+3. Add a note to ``CHANGELOG.rst`` about the changes.
+4. Add yourself to ``AUTHORS.rst``.
+
+
+
+Tips
+----
+
+To run a subset of tests::
+
+    tox -e envname -- pytest -k test_myfeature
+
+To run all the test environments in *parallel*::
+
+    tox -p auto

oemof_demand-0.2.3a1/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) oemof developer group
+
+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 (including the next paragraph) 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.

oemof_demand-0.2.3a1/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: oemof.demand
+Version: 0.2.3a1
+Summary: Creating heat and power demand profiles from annual values
+Author-email: oemof developer group <contact@oemof.org>
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Requires-Dist: numpy >= 2.0
+Requires-Dist: pandas >= 2.1
+Requires-Dist: build ; extra == "build"
+Requires-Dist: check-manifest ; extra == "build"
+Requires-Dist: flake8 ; extra == "build"
+Requires-Dist: flit ; extra == "build"
+Requires-Dist: isort ; extra == "build"
+Requires-Dist: pygments ; extra == "build"
+Requires-Dist: readme-renderer ; extra == "build"
+Requires-Dist: twine ; extra == "build"
+Requires-Dist: sphinx ; extra == "docs"
+Requires-Dist: sphinx_rtd_theme ; extra == "docs"
+Requires-Dist: matplotlib ; extra == "examples"
+Requires-Dist: workalendar ; extra == "examples"
+Requires-Dist: shapely >= 2.0.0 ; extra == "geometry"
+Requires-Dist: geopandas ; extra == "geometry"
+Requires-Dist: coverage ; extra == "test"
+Requires-Dist: matplotlib ; extra == "test"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: geopandas ; extra == "test"
+Requires-Dist: tox ; extra == "tox"
+Project-URL: Changelog, https://oemof-demand.readthedocs.io/en/latest/changelog.html
+Project-URL: Documentation, https://oemof-demand.readthedocs.io/
+Project-URL: Homepage, https://github.com/oemof/oemof-demand
+Project-URL: Issue Tracker, https://github.com/oemof/oemof-demand/issues/
+Provides-Extra: build
+Provides-Extra: docs
+Provides-Extra: examples
+Provides-Extra: geometry
+Provides-Extra: test
+Provides-Extra: tox
+
+========
+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/oemof-demand/workflows/tox%20pytests/badge.svg
+     :target: https://github.com/oemof/oemof-demand/actions?query=workflow%3A%22tox+checks%22
+
+.. |tox-checks| image:: https://github.com/oemof/oemof-demand/workflows/tox%20checks/badge.svg?branch=dev
+     :target: https://github.com/oemof/oemof-demand/actions?query=workflow%3A%22tox+checks%22
+
+.. |packaging| image:: https://github.com/oemof/oemof-demand/workflows/packaging/badge.svg?branch=dev
+     :target: https://github.com/oemof/oemof-demand/actions?query=workflow%3Apackaging
+
+.. |docs| image:: https://readthedocs.org/projects/oemof-demand/badge/?style=flat
+    :target: https://oemof-demand.readthedocs.io/
+    :alt: Documentation Status
+
+.. |coveralls| image:: https://coveralls.io/repos/oemof/oemof-demand/badge.svg?branch=dev&service=github
+    :alt: Coverage Status
+    :target: https://coveralls.io/github/oemof/oemof-demand?branch=dev
+
+.. |version| image:: https://img.shields.io/pypi/v/oemof-demand.svg
+    :alt: PyPI Package latest release
+    :target: https://pypi.org/project/oemof-demand
+
+.. |wheel| image:: https://img.shields.io/pypi/wheel/oemof-demand.svg
+    :alt: PyPI Wheel
+    :target: https://pypi.org/project/oemof-demand
+
+.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/oemof-demand.svg
+    :alt: Supported versions
+    :target: https://pypi.org/project/oemof-demand
+
+.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/oemof-demand.svg
+    :alt: Supported implementations
+    :target: https://pypi.org/project/oemof-demand
+
+.. |commits-since| image:: https://img.shields.io/github/commits-since/oemof/oemof-demand/latest/dev
+    :alt: Commits since latest release
+    :target: https://github.com/oemof/oemof-demand/compare/master...dev
+
+
+
+.. end-badges
+
+Creating heat and power demand profiles from annual values.
+
+* Free software: MIT license
+
+Installation
+============
+
+::
+
+    pip install oemof-demand
+
+You can also install the in-development version with::
+
+    pip install https://github.com/oemof/oemof-demand/archive/master.zip
+
+
+Documentation
+=============
+
+
+https://oemof-demand.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
+

oemof_demand-0.2.3a1/README.rst

@@ -0,0 +1,104 @@
+========
+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/oemof-demand/workflows/tox%20pytests/badge.svg
+     :target: https://github.com/oemof/oemof-demand/actions?query=workflow%3A%22tox+checks%22
+
+.. |tox-checks| image:: https://github.com/oemof/oemof-demand/workflows/tox%20checks/badge.svg?branch=dev
+     :target: https://github.com/oemof/oemof-demand/actions?query=workflow%3A%22tox+checks%22
+
+.. |packaging| image:: https://github.com/oemof/oemof-demand/workflows/packaging/badge.svg?branch=dev
+     :target: https://github.com/oemof/oemof-demand/actions?query=workflow%3Apackaging
+
+.. |docs| image:: https://readthedocs.org/projects/oemof-demand/badge/?style=flat
+    :target: https://oemof-demand.readthedocs.io/
+    :alt: Documentation Status
+
+.. |coveralls| image:: https://coveralls.io/repos/oemof/oemof-demand/badge.svg?branch=dev&service=github
+    :alt: Coverage Status
+    :target: https://coveralls.io/github/oemof/oemof-demand?branch=dev
+
+.. |version| image:: https://img.shields.io/pypi/v/oemof-demand.svg
+    :alt: PyPI Package latest release
+    :target: https://pypi.org/project/oemof-demand
+
+.. |wheel| image:: https://img.shields.io/pypi/wheel/oemof-demand.svg
+    :alt: PyPI Wheel
+    :target: https://pypi.org/project/oemof-demand
+
+.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/oemof-demand.svg
+    :alt: Supported versions
+    :target: https://pypi.org/project/oemof-demand
+
+.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/oemof-demand.svg
+    :alt: Supported implementations
+    :target: https://pypi.org/project/oemof-demand
+
+.. |commits-since| image:: https://img.shields.io/github/commits-since/oemof/oemof-demand/latest/dev
+    :alt: Commits since latest release
+    :target: https://github.com/oemof/oemof-demand/compare/master...dev
+
+
+
+.. end-badges
+
+Creating heat and power demand profiles from annual values.
+
+* Free software: MIT license
+
+Installation
+============
+
+::
+
+    pip install oemof-demand
+
+You can also install the in-development version with::
+
+    pip install https://github.com/oemof/oemof-demand/archive/master.zip
+
+
+Documentation
+=============
+
+
+https://oemof-demand.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

oemof_demand-0.2.3a1/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst