From b02198073a53767a3e3b94c1b0c9551e5e8894c7 Mon Sep 17 00:00:00 2001 From: Patrick Henkel Date: Thu, 30 Oct 2025 08:52:30 +0100 Subject: [PATCH 1/6] Updated readme --- .gitignore | 1 + README.md | 13 +++++++------ 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 200a224..cf63ac7 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ /**.egg-info **/.coverage /docs/build +/venv diff --git a/README.md b/README.md index 9fe13b5..7b06b0f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://rwth-ebc.github.io/physXAI/) ![Coverage](https://raw.githubusercontent.com/RWTH-EBC/physXAI/dc3f25cbff23c06eac5344978b431a2faf27aa1c/build/reports/coverage.svg) -[![DOI:10.2139/ssrn.5276153](http://img.shields.io/badge/DOI-10.2139/ssrn.5276153-0A3874.svg)](http://dx.doi.org/10.2139/ssrn.5276153) +[![DOI:10.1016/j.buildenv.2025.113640](https://img.shields.io/badge/DOI-10.1016%2Fj.buildenv.2025.113640-227BC0)](https://doi.org/10.1016/j.buildenv.2025.113640)
@@ -20,10 +20,10 @@ The toolbox aims to integrate physical knowledge into machine learning models to If you have any questions regarding physXAI, feel free to contact us at ebc-tools@eonerc.rwth-aachen.de ## Installation -1. Create conda or virtual environment with Python 3.12: +1. Create virtual environment with Python 3.12 and activate it: ``` - conda create -n python=3.12 pip - conda activate + python -m venv physXAI + physXAI\Scripts\activate.bat ``` 2. Clone pyhsXAI git repo: ``` @@ -79,7 +79,8 @@ The project is organized into the following directories: - `evaluation`: Modules for evaluating model performance using various metrics. - `utils`: Utility functions and helper scripts used across different parts of the toolbox. - `docs`: Contains documentation for the project. -- `Archive`: Used for archiving older versions of the code, data, or models to keep the main project structure clean. +- `build`: Contains saved test reports. +- `unittests`: Contains unittests for physXAI. ## How to contribute to the development @@ -91,7 +92,7 @@ Furthermore, you are welcome to contribute via Pull Requests. To cite physXAI, please use the following paper: -> Henkel, Patrick and Roß, Simon and Rätz, Martin and Müller, Dirk, Monotonic Physics-Constrained Neural Networks for Model Predictive Control of Building Energy Systems. Available at SSRN: https://ssrn.com/abstract=5276153 or http://dx.doi.org/10.2139/ssrn.5276153 +> Henkel, Patrick and Roß, Simon and Rätz, Martin and Müller, Dirk, Monotonic physics-constrained neural networks for model predictive control of building energy systems. 2025.Available at Building and Environment: https://doi.org/10.1016/j.buildenv.2025.113640 ## Copyright and license This tool is released by RWTH Aachen University, E.ON Energy Research Center, Institute for Energy Efficient Buildings and Indoor Climate
From e9c5928fea9fc5fca46c8948e7dff87f6b899b7a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 30 Oct 2025 07:54:58 +0000 Subject: [PATCH 2/6] Initial plan From 0fe0aa49692ba0ce1628a72e617684244c57151f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 30 Oct 2025 07:56:31 +0000 Subject: [PATCH 3/6] Fix missing space after '2025.' in README citation Co-authored-by: PatrickHenkel1 <77100318+PatrickHenkel1@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b06b0f..c924031 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ Furthermore, you are welcome to contribute via Pull Requests. To cite physXAI, please use the following paper: -> Henkel, Patrick and Roß, Simon and Rätz, Martin and Müller, Dirk, Monotonic physics-constrained neural networks for model predictive control of building energy systems. 2025.Available at Building and Environment: https://doi.org/10.1016/j.buildenv.2025.113640 +> Henkel, Patrick and Roß, Simon and Rätz, Martin and Müller, Dirk, Monotonic physics-constrained neural networks for model predictive control of building energy systems. 2025. Available at Building and Environment: https://doi.org/10.1016/j.buildenv.2025.113640 ## Copyright and license This tool is released by RWTH Aachen University, E.ON Energy Research Center, Institute for Energy Efficient Buildings and Indoor Climate
From 816fde3356dc96bec9894296459b5f8c5c3bb702 Mon Sep 17 00:00:00 2001 From: Patrick Henkel <77100318+PatrickHenkel1@users.noreply.github.com> Date: Thu, 30 Oct 2025 09:15:16 +0100 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c924031..f8b0834 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,15 @@ If you have any questions regarding physXAI, feel free to contact us at ebc-tool 1. Create virtual environment with Python 3.12 and activate it: ``` python -m venv physXAI - physXAI\Scripts\activate.bat ``` + - **On Windows:** + ``` + physXAI\Scripts\activate.bat + ``` + - **On Unix/Linux/macOS:** + ``` + source physXAI/bin/activate + ``` 2. Clone pyhsXAI git repo: ``` git clone https://github.com/RWTH-EBC/physXAI.git From c00d1e83e8d21278ddb0951c185451490b5c0ab8 Mon Sep 17 00:00:00 2001 From: Patrick Henkel <77100318+PatrickHenkel1@users.noreply.github.com> Date: Thu, 30 Oct 2025 09:15:32 +0100 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8b0834..3fa9ef7 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ If you have any questions regarding physXAI, feel free to contact us at ebc-tool ``` source physXAI/bin/activate ``` -2. Clone pyhsXAI git repo: +2. Clone physXAI git repo: ``` git clone https://github.com/RWTH-EBC/physXAI.git ``` From c2648ffb91abc02e15c2e3d1d929c709ae51abd7 Mon Sep 17 00:00:00 2001 From: Patrick Henkel Date: Thu, 30 Oct 2025 09:24:28 +0100 Subject: [PATCH 6/6] Updated --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3fa9ef7..1baa21d 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ Furthermore, you are welcome to contribute via Pull Requests. To cite physXAI, please use the following paper: -> Henkel, Patrick and Roß, Simon and Rätz, Martin and Müller, Dirk, Monotonic physics-constrained neural networks for model predictive control of building energy systems. 2025. Available at Building and Environment: https://doi.org/10.1016/j.buildenv.2025.113640 +> Henkel, Patrick and Roß, Simon and Rätz, Martin and Müller, Dirk, Monotonic physics-constrained neural networks for model predictive control of building energy systems. Building and Environment, 2025, 285, 113640. https://doi.org/10.1016/j.buildenv.2025.113640 ## Copyright and license This tool is released by RWTH Aachen University, E.ON Energy Research Center, Institute for Energy Efficient Buildings and Indoor Climate