AixLib icon indicating copy to clipboard operation
AixLib copied to clipboard

Issue1223 new storage examples

Open LauraMaier opened this issue 2 years ago • 14 comments

This closes #1223

LauraMaier avatar Jul 14 '22 15:07 LauraMaier

@LauraMaier please check feedback from Moritz

tosch4 avatar Oct 12 '22 14:10 tosch4

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 13 '22 18:10 ebc-aixlib-bot

I removed the review request from @MZuschlag to speed up the process now even though the review so far was very helpful! :-)

LauraMaier avatar Oct 14 '22 18:10 LauraMaier

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 14 '22 20:10 ebc-aixlib-bot

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 17 '22 23:10 ebc-aixlib-bot

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 21 '22 18:10 ebc-aixlib-bot

@SvenHinrichs Could you please check why the CI is failing? :)

LauraMaier avatar Oct 21 '22 21:10 LauraMaier

@LauraMaier : The job for your new examples fail, because all examples have unspecified initial conditions:

Generated 350 regression tests.
*** Warning: Unspecified initial conditions in 'RunScript("Resources/Scripts/Dymola/Fluid/Storage/Examples/StorageSimpleExample.mos");'.
*** Warning: Unspecified initial conditions in 'RunScript("Resources/Scripts/Dymola/Fluid/Storage/Examples/StorageSolarCollector.mos");'.
*** Warning: Unspecified initial conditions in 'RunScript("Resources/Scripts/Dymola/Fluid/Storage/Examples/StorageBoiler.mos");'.
Comparison files output by funnel are stored in the directory 'funnel_comp' of size 13.2 MB.
Run 'report' method of class 'Tester' to access a summary of the comparison results.
Number of models with unspecified initial conditions         : 3
Script that runs unit tests had 3 warnings and 0 errors.
See 'simulator-dymola.log' for details.

https://git.rwth-aachen.de/EBC/EBC_all/github_ci/AixLib/-/jobs/3006309

Use FixedInitial will probably solve this issue. While at it, the re-generation of e.g. results in thermal zones or systems should not be necessary. And, which PR comes first? This one or #1226 ?

I will be able to review both in october.

FWuellhorst avatar Oct 22 '22 09:10 FWuellhorst

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 24 '22 06:10 ebc-aixlib-bot

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 24 '22 18:10 ebc-aixlib-bot

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Oct 24 '22 20:10 ebc-aixlib-bot

@FWuellhorst CI hats dann auch endlich mal geschafft :D

LauraMaier avatar Oct 25 '22 00:10 LauraMaier

Errors in regression test. Compare the results on the following page https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

ebc-aixlib-bot avatar Nov 11 '22 02:11 ebc-aixlib-bot

Thank you for making a Pull Request to AixLib!

Our CI pipeline will help you finalize your contribution. Here's what is typically checked:

  • HTML syntax of your models, primarily in your documentation.
  • Adherence to the naming convention in all changed files.
  • Ability to check all models.
  • Ability to simulate all models, if they are examples.
  • If your contribution changes existing reference results.

If HTML errors occur, I will fix the issues using a separate pull request. For the other checks, I will post the results here: https://rwth-ebc.github.io/AixLib/issue1223_NewStorageExamples/index.html

Tips to fix possible naming violations:

  • Stick to the naming guidelines, e.g. Namespace Requirements
  • Do all paramaters, variables, models, etc. have a description?
  • Use absolute paths to classes! -> AixLib.Fluid.HeatExchangers.Radiator - Avoid: HeatExchangers.Radiator

If all CI stages pass and you have addressed possible naming violations, please consider the following:

  • Use "group" and "tab" annotations to achieve a good visualization window.
  • Use units consistently.
  • Instantiate the replaceable medium package as: replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium model"; instead of using a full media model like AixLib.Media.Water directly.
  • Never using absolute paths to files (e.g., C: or D:). Replace them with modelica://AixLib/....
  • Ensure your documentation is helpful and concise.
  • Make sure icons are clear. Please avoid using images!
  • Stick to 80 characters per line, as long as it makes sense.
  • Add or modify examples for new or revised models.
  • Include a simulate-and-plot script as a regression test for new models. How? Follow the documentation here: https://github.com/ibpsa/modelica-ibpsa/wiki/Unit-Tests#how-to-include-models-as-part-of-the-unit-tests Tip: To create the initial script, you can use Dymolas script generator, explained here: https://www.claytex.com/tech-blog/how-to-use-a-plot-script/)

Once you have addressed these points, you can assign a reviewer. Although this process may seem tedious, ensuring CI passes allows the reviewer to focus their time on the actual modeling rather than syntax and unintended breakages caused by your changes.

If you have any questions or issues, please tag a library developer. Once again, thank you for your valuable contribution!

ebc-aixlib-bot avatar Jul 19 '24 12:07 ebc-aixlib-bot