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

Issue 78 new top down parameters for a partial retrofitted bes #79

Merged

Conversation

HvanderStok
Copy link
Contributor

Closes #78

@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/issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES/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
Copy link
Contributor

@HvanderStok : The new more interactive CI is ready :) I will take a look at this PR in the next days.

Copy link
Contributor

@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.

The feature looks really cool! I adjusted minor things (see comments and commits). Also, I added more building records with better names and automatic heat load calculation as this was long overdue and it was fitting for the new example. Once the CI passes we can merge this :)

@@ -1,7 +1,7 @@
within BESMod.Systems.Hydraulical.Generation;
model HeatPumpAndGasBoilerParallel
"Parallel connection of heat pump and gas boiler"
extends BaseClasses.PartialHeatPumpAndGasBoiler;
extends BaseClasses.PartialHeatPumpAndGasBoiler(final use_old_design);
Copy link
Contributor

Choose a reason for hiding this comment

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

I added the default to avoid unwanted behavior if we switch the default in the partial at some point

final QHC1_flow_nominal=Q_flow_nominal[1]*f_design[1],
final mHC1_flow_nominal=mSup_flow_nominal[1],
final QHC1_flow_nominal=Q_flow_design[1]*f_design[1],
final mHC1_flow_nominal=if use_old_design[1] then mSupOld_flow_design[1] else mSup_flow_nominal[1],
Copy link
Contributor

Choose a reason for hiding this comment

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

I added mSup_flow_design to avoid the if statements in the instances. I think these parameters may disappear anyway once I change the distribution layout, lets see.

…ion reference files. Please pull the new files before push again. Plottet Results /issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES/charts/
@ebc-aixlib-bot
Copy link

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/BESMod/issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES/charts

…, perform OM check and simulate together with Dymola
@ebc-aixlib-bot
Copy link

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

…ion reference files. Please pull the new files before push again. Plottet Results /issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES/charts/
@ebc-aixlib-bot
Copy link

Errors in regression test. Compare the results on the following page\n https://rwth-ebc.github.io/BESMod/issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES/charts

…ion reference files. Please pull the new files before push again. Plottet Results /issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES/charts/
@FWuellhorst FWuellhorst merged commit 9651d04 into main Jul 16, 2024
1 check passed
@FWuellhorst FWuellhorst deleted the issue-78-New_top-down_parameters_for_a_partial_retrofitted_BES branch July 16, 2024 14:48
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.

New top-down parameters for a partial retrofitted BES
3 participants