Skip to content

Om bugfixes#138

Merged
HvanderStok merged 13 commits into
mainfrom
om_bugfixes
Apr 21, 2026
Merged

Om bugfixes#138
HvanderStok merged 13 commits into
mainfrom
om_bugfixes

Conversation

@FWuellhorst
Copy link
Copy Markdown
Contributor

@FWuellhorst FWuellhorst commented Mar 31, 2026

This PR adds bugfixes to let BESMod work in OpenModelica.

I removed the temperature outputs using the existing use_openModelica boolean until this issue is resolved in OpenModelica: OpenModelica/OpenModelica#15282

@ebc-aixlib-bot
Copy link
Copy Markdown

Errors in regression test. Compare the results on the following page
https://rwth-ebc.github.io/BESMod/om_bugfixes/charts

@ebc-aixlib-bot
Copy link
Copy Markdown

Thank you for making a Pull Request to BESMod!

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/BESMod/om_bugfixes/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! -> BESMod.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 BESMod.Media.Water directly.
  • Never using absolute paths to files (e.g., C: or D:). Replace them with modelica://BESMod/....
  • 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!

@FWuellhorst FWuellhorst requested a review from HvanderStok March 31, 2026 11:39
@HvanderStok HvanderStok merged commit 0e61e47 into main Apr 21, 2026
@HvanderStok HvanderStok deleted the om_bugfixes branch April 21, 2026 07: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.

3 participants