Merge pull request #588 from e2nIEE/develop

release 0.9.0
e2nIEE · Dec 22, 2023 · 0e74750 · 0e74750
2 parents 59cf3c3 + 613fe60
commit 0e74750
Show file tree

Hide file tree

Showing 415 changed files with 3,122 additions and 1,555 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -75,28 +75,30 @@ jobs:
     needs: upload
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
         os:  [ ubuntu-latest, windows-latest ]
     steps:
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pytest igraph pytest-split numba
+          python -m pip install pytest igraph pytest-split
+          if [${{ matrix.python-version != '3.11' }}]; then python -m pip install numba; fi
+        shell: bash
       - name: Install pandapipes from TestPyPI
         if: ${{ inputs.upload_server == 'testpypi'}}
         run: |
-          pip install --no-cache-dir -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pandapipes
+          python -m pip install --no-cache-dir -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pandapipes
       - name: Install pandapipes from PyPI
         if: ${{ inputs.upload_server == 'pypi'}}
         run: |
-          pip install pandapipes
+          python -m pip install pandapipes
       - name: List all installed packages
         run: |
-          pip list
+          python -m pip list
       - name: Test with pytest
         run: |
           pytest --pyargs pandapipes.test
diff --git a/.github/workflows/run_tests_develop.yml b/.github/workflows/run_tests_develop.yml
@@ -14,53 +14,54 @@ on:
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        os:  [ ubuntu-latest, windows-latest ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pytest igraph pytest-split numba
+          python -m pip install pytest igraph pytest-split
+          if [${{ matrix.python-version != '3.11' }}]; then python -m pip install numba; fi
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
           python -m pip install git+https://github.com/e2nIEE/pandapower@develop#egg=pandapower
-          pip install .
+          python -m pip install .
+        shell: bash
       - name: List all installed packages
         run: |
-          pip list
+          python -m pip list
       - name: Test with pytest
         if: ${{ matrix.python-version != '3.9' }}
         run: |
-          pytest
+          python -m pytest
       - name: Test with pytest and Codecov
         if: ${{ matrix.python-version == '3.9' }}
         run: |
           python -m pip install pytest-cov
-          pytest --cov=./ --cov-report=xml
+          python -m pytest --cov=./ --cov-report=xml
       - name: Upload coverage to Codecov
         if: ${{ matrix.python-version == '3.9' }}
         uses: codecov/codecov-action@v1
         with:
           verbose: true
 
   linting:
-
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.8']
-
+        python-version: ['3.10']
+        os:  [ ubuntu-latest, windows-latest ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -69,10 +70,11 @@ jobs:
           python -m pip install flake8
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
           python -m pip install git+https://github.com/e2nIEE/pandapower@develop#egg=pandapower
-          pip install .
+          python -m pip install .
+        shell: bash
       - name: List all installed packages
         run: |
-          pip list
+          python -m pip list
       - name: Lint with flake8 (syntax errors and undefinded names)
         run: |
           # stop the build if there are Python syntax errors or undefined names
@@ -83,39 +85,42 @@ jobs:
           flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
 
   tutorial_tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        os:  [ ubuntu-latest, windows-latest ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pytest nbmake pytest-xdist pytest-split igraph numba 
+          python -m pip install pytest nbmake pytest-xdist pytest-split igraph
+          if [${{ matrix.python-version != '3.11' }}]; then python -m pip install numba; fi
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
           python -m pip install git+https://github.com/e2nIEE/pandapower@develop#egg=pandapower
-          pip install .
+          python -m pip install .
+        shell: bash
       - name: List all installed packages
         run: |
-          pip list
+          python -m pip list
       - name: Test with pytest
         run: |
-          pytest --nbmake -n=auto "./tutorials"
+          python -m pytest --nbmake -n=auto "./tutorials"
 
   docs_check:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.8' ]
+        python-version: [ '3.10' ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Check docs for Python ${{ matrix.python-version }}

diff --git a/.github/workflows/run_tests_master.yml b/.github/workflows/run_tests_master.yml
@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-# pandapipes-master branch has to work with pandapower-master branch
+# pandapipes-master branch is designed to work with pandapower-master branch
 
 name: ppipes_master
 
@@ -13,77 +13,81 @@ on:
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
-
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        os:  [ ubuntu-latest, windows-latest ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pytest igraph pytest-split numba
+          python -m pip install pytest igraph pytest-split
+          if [${{ matrix.python-version != '3.11' }}]; then python -m pip install numba; fi
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
           python -m pip install git+https://github.com/e2nIEE/pandapower@master#egg=pandapower;
-          pip install .
+          python -m pip install .
+        shell: bash
       - name: List all installed packages
         run: |
-          pip list
+          python -m pip list
       - name: Test with pytest
         if: ${{ matrix.python-version != '3.9' }}
         run: |
-          pytest
+          python -m pytest
       - name: Test with pytest and Codecov
         if: ${{ matrix.python-version == '3.9' }}
         run: |
           python -m pip install pytest-cov
-          pytest --cov=./ --cov-report=xml
+          python -m pytest --cov=./ --cov-report=xml
       - name: Upload coverage to Codecov
         if: ${{ matrix.python-version == '3.9' }}
         uses: codecov/codecov-action@v1
         with:
           verbose: true
 
   tutorial_tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        os:  [ ubuntu-latest, windows-latest ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pytest nbmake pytest-xdist pytest-split igraph numba 
+          python -m pip install pytest nbmake pytest-xdist pytest-split igraph
+          if [${{ matrix.python-version != '3.11' }}]; then python -m pip install numba; fi
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
           python -m pip install git+https://github.com/e2nIEE/pandapower@master#egg=pandapower
-          pip install .
+          python -m pip install .
+        shell: bash
       - name: List all installed packages
         run: |
-          pip list
+          python -m pip list
       - name: Test with pytest
         run: |
-          pytest --nbmake -n=auto "./tutorials"
+          python -m pytest --nbmake -n=auto "./tutorials"
 
   docs_check:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.8' ]
+        python-version: [ '3.10' ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Check docs for Python ${{ matrix.python-version }}

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,9 +1,10 @@
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
 python:
-    version: 3.7
     install:
-       - method: pip
-         path: .
-         extra_requirements:
-            - docs
+      - requirements: doc/requirements.txt
diff --git a/AUTHORS b/AUTHORS
@@ -1,9 +1,9 @@
-Copyright (c) 2020-2023 by Fraunhofer Institute for Energy Economics
+Copyright (c) 2020-2024 by Fraunhofer Institute for Energy Economics
 and Energy System Technology (IEE), Kassel, and University of Kassel. All rights reserved.
 
 Lead Developers:
     - Daniel Lohmeier
-    - Simon Ruben Drauz
+    - Simon Ruben Drauz-Mauel
     - Jolando Marius Kisse
 
 Main Contributors:

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,32 @@
 Change Log
 =============
 
+[0.9.0] - 2023-12-22
+-------------------------------
+
+- [ADDED] multiple creation of heat exchanger
+- [ADDED] support Python 3.11 (now included in test pipeline)
+- [ADDED] after the connectivity check, intercept the pipeflow if no more nodes are in-service (heat and hydraulic)
+- [ADDED] adding biomethane (pure and treated) as additonal fluid
+- [ADDED] result tables can be assembled modularly
+- [CHANGED] dropped support for Python 3.7 (no longer included in test pipeline)
+- [CHANGED] connectivity check now separated by hydraulics and heat_transfer calculation, so that also results can differ in some rows (NaN or not)
+- [CHANGED] dynamic creation of lookups for getting pit as pandas tables
+- [CHANGED] components can have their own internal arrays for specific calculations (e.g. for compressor pressure ratio), so that the pit does not need to include such component specific entries
+- [CHANGED] .readthedocs.yml due to deprecation
+- [CHANGED] changing from setuptools flat-layout into src-layout
+- [CHANGED] calculate thermal derivative globally, adaptions before/after can be done component-wise
+- [CHANGED] moving 'PipeflowNotConverged' error from pipeflow to pipeflow_setup
+- [CHANGED] moving 'result_extraction' under pf folder
+- [FIXED] in STANET converter: bug fix for heat exchanger creation and external temperatures of pipes added
+- [FIXED] build igraph considers all components
+- [FIXED] creating nxgraph and considering pressure circulation pumps correctly
+- [FIXED] error in tutorial 'circular flow in a district heating grid'
+- [FIXED] caused error during 'pip install pandapipes'
+- [REMOVED] broken travis badge removed from readme
+- [REMOVED] branch TINIT removed as it is not a solution variable, temperature determined on the fly
+- [REMOVED] 'converged' setting from options
+
 [0.8.5] - 2023-06-19
 -------------------------------
 - [FIXED] consider ambient pressure in calculation of compression power for pumps/compressors

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2020-2023 by Fraunhofer Institute for Energy Economics
+Copyright (c) 2020-2024 by Fraunhofer Institute for Energy Economics
 and Energy System Technology (IEE), Kassel, and University of Kassel. Further
 contributions by individual contributors (see AUTHORS file for details). All rights reserved.
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,7 +1,3 @@
-include LICENSE AUTHORS README.rst CHANGELOG.rst .github/**/*.yml
-global-include *.json
-global-include *.csv
-global-include *.txt
+graft src
 
-prune doc*
-prune tutorials*
+include LICENSE AUTHORS README.rst CHANGELOG.rst .github/**/*.yml
diff --git a/README.rst b/README.rst
@@ -18,10 +18,6 @@
    :target: http://pandapipes.readthedocs.io/
    :alt: docs
 
-.. image:: https://travis-ci.org/e2nIEE/pandapipes.svg?branch=master
-   :target: https://travis-ci.org/e2nIEE/pandapipes/branches
-   :alt: travis
-
 .. image:: https://codecov.io/gh/e2nIEE/pandapipes/branch/master/graph/badge.svg
    :target: https://codecov.io/github/e2nIEE/pandapipes?branch=master
    :alt: codecov