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

86 nonlinear heating curve #87

Merged
merged 8 commits into from
Nov 8, 2024
Merged

86 nonlinear heating curve #87

merged 8 commits into from
Nov 8, 2024

Conversation

FWuellhorst
Copy link
Contributor

Closes #86 and fixes a minor bug introduced in #82

@ebc-aixlib-bot
Copy link

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

@ebc-aixlib-bot
Copy link

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/86_nonlinearHeatingCurve/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!

@ebc-aixlib-bot
Copy link

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

@ebc-aixlib-bot
Copy link

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

…nal based on the heating curve affects HP size, and, thus temperatures and electric heater usage slightly
@ebc-aixlib-bot
Copy link

Reference results have been displayed graphically and are created under the following page https://rwth-ebc.github.io/BESMod/86_nonlinearHeatingCurve/charts

…ion reference files. Please pull the new files before push again. Plottet Results /86_nonlinearHeatingCurve/charts/
@FWuellhorst FWuellhorst merged commit 7f16602 into main Nov 8, 2024
1 check passed
@FWuellhorst FWuellhorst deleted the 86_nonlinearHeatingCurve branch November 8, 2024 13:56
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.

Nonlinear ideal heating curve
2 participants