Skip to content

Conversation

@lucasverleyen
Copy link
Member

@lucasverleyen lucasverleyen commented Jun 20, 2025

Fixes #1444 and #1408

@lucasverleyen lucasverleyen self-assigned this Jun 20, 2025
@lucasverleyen lucasverleyen marked this pull request as draft June 20, 2025 09:43
@lucasverleyen lucasverleyen requested review from jelgerjansen and removed request for jelgerjansen July 30, 2025 15:44
@lucasverleyen lucasverleyen marked this pull request as ready for review July 30, 2025 15:45
@lucasverleyen lucasverleyen added this to the Release 4.0.0 milestone Jul 30, 2025
@lucasverleyen
Copy link
Member Author

lucasverleyen commented Aug 4, 2025

@jelgerjansen thanks a lot for the review! Concerning the references to the IDEAS development papers.
I am not in favour of adding a list to the readme. But I wanted to restructure the References.mo in the User's Guide.
As an example, I have this image. If you, @annadellisola and @jelgerjansen, like it, I can complete the list that was before in the readme.
Additionally, I expect that the papers under Main references will be mentioned in the respective models (it is for Awbi, Buchberg, Hamilton, Jurges, Mohr, Oppenheim). So I suggest removing that list.
image

@lucasverleyen
Copy link
Member Author

@jelgerjansen @annadellisola I have restructured and updated the User's Guide in the main IDEAS package. Could you please review this? For now, only Filip's funding was mentioned. I partially completed the list in IDEAS/UsersGuide/Acknowledgements. I still need to check with Lieve for the KU Leuven part. @kldjonge, do you want to mention your/UGent funding for IDEAS developments?

Before the new IDEAS release, we need to complete IDEAS/UsersGuide/ReleaseNotes/Version_4_0_0.

@jelgerjansen I have double-checked the list of funding and contributors with Lieve.

@jelgerjansen
Copy link
Contributor

@lucasverleyen OK for me to restructure the References.mo file.
I swept over the .mo files and could find all papers mentioned in the references, except the work of Jürges, Kenelly, and Waldon.

@annadellisola
Copy link
Contributor

@lucasverleyen I like the new structure of References.mo file. I also think it would make more sense to reference the relevant papers directly in the model documentation instead of having them in Main references

@lucasverleyen
Copy link
Member Author

lucasverleyen commented Aug 6, 2025

@jelgerjansen @annadellisola I have restructured the References.mo file.

  • I have added the correct hyperlinks of the "main references" to the respective models, and I have removed those from the References.mo.

  • I have added the papers on the development of IDEAS, which were before in the readme of the repo. However: i) I did not include the paper on StROBe (has nothing to do with IDEAS development), ii) I did not add the PhD of Ruben Baetens (the papers are already included), iii) I added two more papers from the applications, which are more on the development in my opinion.

  • I could not find Kenelly. But when I looked for "triangle", I was referred to IDEAS.Electrical.AC.ThreePhaseBalanced.Loads.Impedance. There, the parameter "star" is declared to define a star or triangle configuration. I have added Kenelly (a basic paper about star and triangle configurations in electrical networks) there.

  • I could find "Waldon" using the title, but it is Walton, so this problem is solved.

  • I could not find ISO 13370 (on the heat load calculations). @jelgerjansen, could you find it? Where do I add this reference?

  • I could not find Defraye, also not when I looked for the keywords in the title. I suggest removing the reference.

  • I could not find Jürges, also not when I looked for the keywords (both in German and English). I suggest removing the reference. It seems like a basic reference.

Can you do a new (final?) review? Btw, normally, I addressed all your comments/suggestions.

Copy link
Contributor

@annadellisola annadellisola left a comment

Choose a reason for hiding this comment

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

Thanks a lot @lucasverleyen for all the effort! I gave some minor comments on the references.
Regarding the papers you did not find:

  • ISO 13370: could be referenced in IDEAS.Buildings.Components.SlabOnGround, where it seems that UEqui is calculated according to the standard
  • Defraye 2011: I was also not able to find a direct reference. IDEAS.Buildings.Components.OuterWall might use some correlations mentioned in the paper, but I did not manage to find the exact one
  • Jurges 1924: no reference found

Co-authored-by: Anna Dell'Isola <155304381+annadellisola@users.noreply.github.com>
@lucasverleyen
Copy link
Member Author

Thanks a lot @lucasverleyen for all the effort! I gave some minor comments on the references. Regarding the papers you did not find:

  • ISO 13370: could be referenced in IDEAS.Buildings.Components.SlabOnGround, where it seems that UEqui is calculated according to the standard
  • Defraye 2011: I was also not able to find a direct reference. IDEAS.Buildings.Components.OuterWall might use some correlations mentioned in the paper, but I did not manage to find the exact one
  • Jurges 1924: no reference found

@annadellisola thanks for your suggestions. I have added ISO 13370 as explained. I have removed Defraye and Jurges.

@lucasverleyen
Copy link
Member Author

@annadellisola @jelgerjansen thanks again for your useful input! I have addressed all comments. I think this PR is ready.

@lucasverleyen lucasverleyen merged commit 2e9fe79 into open-ideas:master Aug 8, 2025
3 of 4 checks passed
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 User's Guide for new release Update applications of IDEAS in README

3 participants