Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ibpsa merge custom errors #1517

Merged
merged 35 commits into from
Jul 25, 2024
Merged

Ibpsa merge custom errors #1517

merged 35 commits into from
Jul 25, 2024

Conversation

FWuellhorst
Copy link
Contributor

fix errors which are due to moved files or changed model behaviour.

@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

1 similar comment
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

@ebc-aixlib-bot
Copy link
Contributor

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/IBPSA_MergeCustomErrors/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
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

1 similar comment
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

1 similar comment
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

FWuellhorst and others added 2 commits July 23, 2024 15:44
…ion reference files. Please pull the new files before push again. Plottet Results /IBPSA_MergeCustomErrors/charts/
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

1 similar comment
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

1 similar comment
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

FWuellhorst and others added 3 commits July 24, 2024 17:19
…ion reference files. Please pull the new files before push again. Plottet Results /IBPSA_MergeCustomErrors/charts/
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

1 similar comment
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

@FWuellhorst
Copy link
Contributor Author

@martinkremer
I updated the reference results for GenericAHU model and changed the computation of the efficiency to the Euler number. Thus, the global efficiency drops from 66.5 % to 49 %, leading to slightly changed results.

image

FWuellhorst and others added 8 commits July 25, 2024 08:02
…ion reference files. Please pull the new files before push again. Plottet Results /IBPSA_MergeCustomErrors/charts/
… radau leads to failed simulation on linux (maybe due to older dymola version in CI)
…ion reference files. Please pull the new files before push again. Plottet Results /IBPSA_MergeCustomErrors/charts/
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/AixLib/IBPSA_MergeCustomErrors/charts

Copy link
Contributor Author

@FWuellhorst FWuellhorst left a comment

Choose a reason for hiding this comment

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

@KremerMartin @larissakuehn @TobiasSpratte
Can someone of you have a quick look or just approve this PR? The CI passes, and I explained all changes below. I left the base branch not main to see what I changed aside from the +1000 new files in the actual merge of IBPSA.

This PR fixes errors and introduces changes based on the latest IBPSA merge.

  • Either delete deleted in IBPSA or move to obsolete
  • rename models to allow regression tests
  • fix missing PumpHeadControlled
  • Adjust IndoorSwimmingPool mover model, already discussed with @larissakuehn. Changes in regression results approved
  • Change solver in simulate and plot scripts of ROM models to CVode, as in TEASER and because equippedExamples lead to stalled simulations in CI with Radau.
  • Update NRPM models in Systems as nrpm is deprectated. As the default efficiency calculation in IBPSA was changed to Euler (with lower efficiencies), update GenericAHU example and results (only slight deviations) as approved by @KremerMartin
  • Update version to 2.0.0 as Mover changes are not fully backwards compatible and the HeatPump model will move to obsolete at the hackday tomorrow, now that the new HP model is finally in AixLib.

@KremerMartin KremerMartin self-requested a review July 25, 2024 12:21
KremerMartin
KremerMartin previously approved these changes Jul 25, 2024
Copy link
Contributor

@KremerMartin KremerMartin 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 @FWuellhorst for your effort. Looks fine. :)

@FWuellhorst FWuellhorst changed the base branch from IBPSA_MergeCustim to main July 25, 2024 12:37
@FWuellhorst FWuellhorst dismissed KremerMartin’s stale review July 25, 2024 12:37

The base branch was changed.

@FWuellhorst FWuellhorst merged commit e2a5f1a into main Jul 25, 2024
1 check passed
@FWuellhorst FWuellhorst deleted the IBPSA_MergeCustomErrors branch July 25, 2024 13:50
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.

4 participants