Issue1389 detailed house

[LoneMeertens]

Fixes #1389.
More detailed documentation and result visualization can be added if deemed valuable. This can be combined with open-ideas/__CrashCourse__#25. and #1374

[lucasverleyen]

@LoneMeertens, thank you for addressing the issue! I really like the new structure, a great improvement. :-) Also, adding more documentation/explanation provides significant added value.

• I suggest including Refactoring exercise 3 __CrashCourse__#25 and Update Tutorial IDEAS #1374 as well in this PR, which seems more convenient than having too many issues and PRs related to the same models.
• Regarding more detailed documentation and result visualisation, I suggest maintaining consistency with the SimpleHouse tutorial from IBPSA and following a similar approach. This tutorial has been thoroughly reviewed recently and is consequently in good shape.
• Additionally, we can add DetailedHouse10 as a final Example at the same level as SimpleHouse.

[LoneMeertens]

@lucasverleyen Thank you for the detailed feedback and suggestions! 😊 I'm glad you like the new structure and the additional documentation.

I’ll take this up and include open-ideas/CrashCourse#25 and Update Tutorial IDEAS #1374 in this PR as suggested—it does make sense to consolidate related issues and PRs.

Regarding the documentation and result visualization, I'll align it with the SimpleHouse tutorial from IBPSA to ensure consistency and maintain the high standard of quality. I'll also add DetailedHouse10 (as DetailedHouse) as a final example, positioned at the same level as SimpleHouse.

Thanks again for the valuable input!

[lucasverleyen]

@LoneMeertens perfect! Thanks a lot! In the mean time, I have looked at the unit tests, but currently, I am not able to solve the issues. DetailedHouse5 does work, but the other examples do not and I don't know why... to be continued in the new year ;-)

[lucasverleyen]

@jelgerjansen good catch (__Dymola_Commands)! I suggest adding this to the documentation of the testing framework: https://github.com/open-ideas/IDEAS/blob/master/IDEAS/Resources/Scripts/tests/README.md under Developing new tests. Something like: "Make sure that the file name and path in the model annotation under __Dymola_Comands correspond to the name and path to the .mos file in Resources/Scripts/Dymola/... " What do you think?

[jelgerjansen]

@LoneMeertens thank you for addressing this issue. Most comments are related to model documentation and syntax.

The models previously didn't run due to the reference to an unexisting mos file in __Dymola_Commands(). This does not generates warnings when translating the model in Dymola, but it does for the unit tests. I solved this issue via commits 8cca500 and e8f49c5

Once you've also addressed the other related issues (e.g. #1374), I'll do another review.

[jelgerjansen]

@jelgerjansen good catch (__Dymola_Commands)! I suggest adding this to the documentation of the testing framework: https://github.com/open-ideas/IDEAS/blob/master/IDEAS/Resources/Scripts/tests/README.md under Developing new tests. Something like: "Make sure that the file name and path in the model annotation under __Dymola_Comands correspond to the name and path to the .mos file in Resources/Scripts/Dymola/... " What do you think?

@lucasverleyen the __Dymola_Commands is not used when running the unit tests, but links the mos file to the model such that the experiment in the mos file is executed when running the "Simulate and plot" command in Dymola. Note that you don't need a __Dymola_Commands to run the unit tests (which is for example why DetailedHouse5 could be run without problems), but is easier if you want to run unit tests mos files of certain models in Dymola. Therefore, I would maybe not add it, as it is no hard requirement.

If you add it, the file in __Dymola_Commands should of course be linked to the correct mos file (but this is rather a general requirement rather than a unit test requirement). I think that BuildingsPy performs a more detailed check of the model when translating compared to Dymola, as the latter did not throw any errors.

[lucasverleyen]

@LoneMeertens, thanks for all the changes, huge improvements! :-)
I have added a few comments on the image file names. And I have taken the freedom to improve some graphics and documentation myself. I'll have a detailed look at DetailedHouse9 and 10 before the beginning of next week, as it is too late now...

• I see that the unit tests still fail. That is most likely because many component model names have changed, so the .mos files should still be updated.

[jelgerjansen]

I did some more updates, which resolves all previously mentioned

To do:

1. Change exercise 7: use pump to decouple the flow rates in the primary and secondary side of the network to avoid chattering (which occurs due to a combination of an on/off HP and too small flow rates through the radiators (and therefore the heat pump)). A similar control approach is used in the CONTROL exercise session of the Thermal Systems course
2. Update figures and quantitative results in Modelica documentation.
3. Update reference results (for the unit tests)
4. Update figures and quantitative results in the Crash course material (https://github.com/open-ideas/__CrashCourse__)

@lucasverleyen and @LoneMeertens unless you would like to spend time on this during the weekend, let's discuss this further on Monday.