Skip to content

Updated readme - #28

Merged
PatrickHenkel1 merged 7 commits into
mainfrom
27-update-citation
Oct 30, 2025
Merged

PatrickHenkel1 merged 7 commits into
mainfrom
27-update-citation

Conversation

@PatrickHenkel1

Copy link
Copy Markdown
Collaborator

No description provided.

@PatrickHenkel1 PatrickHenkel1 linked an issue Oct 30, 2025 that may be closed by this pull request

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the project's publication reference from a preprint to the final published version and modernizes the installation instructions. The DOI has been updated from the SSRN preprint (10.2139/ssrn.5276153) to the final Building and Environment journal publication (10.1016/j.buildenv.2025.113640).

  • Updated citation and DOI badge to reference the final published journal article
  • Simplified installation instructions to use Python venv instead of conda
  • Updated project structure documentation to reflect actual directories (build and unittests instead of Archive)

Reviewed Changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Updated DOI badge and citation to published journal article, changed installation from conda to venv, and corrected project structure documentation
.gitignore Added /venv to ignore list to support the updated venv-based installation workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
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

Copilot AI Oct 30, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space after '2025.' - should be '2025. Available' instead of '2025.Available'.

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

Copilot AI commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

@PatrickHenkel1 I've opened a new pull request, #29, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits October 30, 2025 07:56
Co-authored-by: PatrickHenkel1 <77100318+PatrickHenkel1@users.noreply.github.com>
Fix missing space in README citation

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
PatrickHenkel1 and others added 2 commits October 30, 2025 09:15
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
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

Copilot AI Oct 30, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation format is incomplete. It should include the journal name, volume, and page numbers. A more complete format would be: '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, 268, 113640. https://doi.org/10.1016/j.buildenv.2025.113640'

Suggested change
> 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, 268, 113640. https://doi.org/10.1016/j.buildenv.2025.113640

Copilot uses AI. Check for mistakes.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 1 out of 2 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@PatrickHenkel1
PatrickHenkel1 merged commit 979b572 into main Oct 30, 2025
10 checks passed
@PatrickHenkel1
PatrickHenkel1 deleted the 27-update-citation branch October 30, 2025 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Citation

4 participants