Merge pull request #76 from e2nIEE/develop

Merge develop onto master

Author: pmohanty943

.github/workflows/run_tests_develop.yml

@@ -41,6 +41,7 @@ jobs:
       - name: Upload coverage to Codecov
         if: ${{ matrix.python-version == '3.11' }}
         uses: codecov/codecov-action@v4
+        continue-on-error: true
         with:
           verbose: true
           token: ${{ secrets.CODECOV_TOKEN }}

AUTHORS

@@ -20,10 +20,16 @@ Pratikshya Mohanty: Universität Kassel
 
 Erik Prade: Universität Kassel
 
+Carl Ritzenhoff: Universität Kassel
+
 Marko Keber: University of Ljubljana
 
 Izak Oberčkal Pluško: University of Ljubljana
 
+Dr. Katja Klinar: University of Ljubljana
+
+Dr. Tine Seljak: University of Ljubljana
+
 
 
 Contributors
@@ -32,11 +38,11 @@ Contributors
 Bente Schmidt
 
 Dimitri Novarèze
- 
+
 Alain Dimier
 
 Camille Laporte
- 
+
 
 
 Coordination
@@ -46,6 +52,6 @@ Dr. Odile Capron: Universität Kassel
 
 Dr. Anton Bergmann: Universität Kassel
 
-Prof. Dr. Lars Peter Lauven: Universität Kassel
-
+Dr. Ruben Schauer: Universität Kassel
 
+Prof. Dr. Lars Peter Lauven: Universität Kassel

CHANGELOG.rst

@@ -1,3 +1,43 @@
+[0.1.3] 2025-11-20
+------------------------------
+- [ADDED] Solar thermal model
+- [ADDED] PV model
+- [ADDED] Rankine cycle CHP model
+- [ADDED] `Converter` controller: for converting generic to fluid mix mapping as a functionality addition
+- [FIXED] `Supervisor` controller
+- [ADDED] Option to rerun time step with run_timeseries
+- [ADDED] BHP parameters adapted and updated tutorials
+- [ADDED] `NetworkCoupling` controller: Can be used to create a coupling between a prosumer and a pandapipes or pandapower network and a tutorial demonstrating building an energy system that couples multiple networks
+
+
+[0.1.2] - 2025-05-16
+-------------------------------
+- [ADDED] `Supervisor` controller: allows dynamic attribute control based on input conditions and logical rules.
+- [ADDED] `SupervisorData` class: handles input structure for the supervisor controller.
+- [ADDED] `Rule` class: defines single-condition logic to modify prosumer attributes.
+- [ADDED] `CombiningRules` class: supports logical combination (AND/OR) of multiple `Rule` instances.
+- [DOCS] Added detailed documentation and usage examples for the supervisor.
+
+[0.1.2] - 2025-05-07
+-------------------------------
+- [ADDED] `ConstProfileController` now supports automatic period detection from the DataFrame via a `period` column if no period is explicitly set.
+- [CHANGED] Improved period handling logic to reduce user configuration burden and improve flexibility.
+- [UPDATED] Tests and tutorials to reflect the new behavior in period detection and ensure compatibility with updated controller logic.
+- [FIXED] Runtime Warning due to negative value inside np.log
+- [CHANGED] merged duplicate code from dry cooler and heat exchanger
+
+
+[0.1.2] - 2025-05-02
+-------------------------------
+- [ADDED] `check_levels` function: ensures that all controllers in a prosumer have the same execution level (with exceptions for ConstProfile and pandapower/pandapipes).
+- [ADDED] `check_controllers_orders` function: validates that initiator controllers execute before responder controllers, based on level and order attributes.
+- [ADDED] `check_mappings_orders` function: checks that controller mapping orders are continuous and start from zero.
+- [ADDED] `check_order` argument to the prosumer constructor: allows enabling or disabling all order validation mechanisms.
+- [UPDATED] Tests and tutorials to comply with new order checking mechanisms (minor fixes for compatibility).
+- [FIXED] Incorrect reference to "pandapipes" in `CONTRIBUTING.rst` now correctly mentions "pandaprosumer".
+- [CHANGED] Unit correction in `dry_cooler.rst` documentation.
+- [ADDED] q_exchanged_kw in Heat Exchanger result columns.
+
 [0.1.2] - 2025-04-22
 -------------------------------
 - [FIXED] ice chp documentation

CONTRIBUTING.rst

@@ -12,7 +12,7 @@ Setup your git repository
 If you want to contribute for the first time, you can set up your environment like this:
 
 #. If you have not done it yet: install git and create a github account
-#. Create a fork of the official pandapipes repository by clicking on "Fork" on the official pandapipes repository (see https://help.github.com/articles/fork-a-repo/)  
+#. Create a fork of the official pandapipes repository by clicking on "Fork" on the official pandapipes repository (see https://help.github.com/articles/fork-a-repo/)
 #. Clone the forked repository to your local machine: ::
 
     git clone https://github.com/YOUR-USERNAME/pandaprosumer.git
@@ -32,11 +32,11 @@ If you want to contribute for the first time, you can set up your environment li
     [branch "develop"]
         remote = origin
         merge = refs/heads/develop
-        
+
 The develop branch is now configured to automatically track the official pandapipes develop branch. So if you are on the develop branch and use: ::
 
     git pull
-    
+
 your local repository will be updated with the newest changes in the official pandaprosumer repository.
 
 Since you cannot push directly to the official pandaprosumer repository, if you are on develop and do: ::
@@ -74,15 +74,15 @@ Contribute from your develop branch
 
     git add --all
     git commit -m"commit message"
-   
+
    If there is an open issue that the commit belongs to, reference the issue in the commit message, for example for issue 3: ::
 
     git commit -m"commit message #3"
 
 #. Push your changes to your fork: ::
 
     git push
-    
+
 #. Put in a Pull request to the main repository: https://help.github.com/articles/creating-a-pull-request-from-a-fork/
 
 #. For each Pull request, some checks will start automatically. It is required that the travis-ci
@@ -93,7 +93,7 @@ Contribute from your develop branch
     git add --all
     git commit -m"I have updated the pull request after discussions #3"
     git push
-    
+
    The pull request will be automatically updated.
 
 Contribute from a feature branch
@@ -110,24 +110,24 @@ Contribute from a feature branch
 #. Create a new feature branch: ::
 
     git checkout -b my_branch
-    
+
 #. Make changes in the code
 
 #. Add and commit your change: ::
 
     git add --all
     git commit -m"commit message"
-   
+
    If there is an open issue that the commit belongs to, reference the issue in the commit message, for example for issue 3: ::
 
     git commit -m"commit message #3"
-    
+
 #. Push your changes to your fork: ::
 
     git push -u pp_fork my_branch
-    
-   this pushes the new branch to your fork and also sets up the remote tracking. 
-   
+
+   this pushes the new branch to your fork and also sets up the remote tracking.
+
 #. Put in a Pull request to the official repository (see https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
 
 #. For each Pull request, some checks will start automatically. It is required that the travis-ci
@@ -156,4 +156,4 @@ Adding Tests for new functionality
 
 If you have added new functionality, you should also add a new function that tests this functionality. pytest automatically detects all functions in the pandaprosumer/test folder that start with 'test' and are located in a file that also starts with 'test' as relevant test cases.
 
-Tests with pytest can be quite complex. For how to handle e.g. pytest fixtures, xfailing tests etc. refer to the documentation of pytest.
+Tests with pytest can be quite complex. For how to handle e.g. pytest fixtures, xfailing tests etc. refer to the documentation of pytest.

contributing.rst

@@ -14,7 +14,7 @@
 project = 'Pandaprosumer'
 copyright = '2025, Uni Kassel, European Institute for Energy Research'
 author = 'Uni Kassel, European Institute for Energy Research'
-release = '0.1'
+release = '0.3'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

doc/source/conf.py

@@ -18,3 +18,14 @@ The controller can write the values to the any input of a controller in the same
 
 .. autoclass:: pandaprosumer.controller.const_profile.ConstProfileController
     :members:
+
+
+Period Handling
+================
+
+A period needs to be defined to use the `ConstProfileController`.
+
+If no period is explicitly set for the controller, it will try to detect a `period` column in the DataFrame provided by the DataSource.
+If this column exists, a default period will automatically be created and used.
+
+If neither a period is defined nor a `period` column is present in the DataFrame, an error will be raised.