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

1520 new hp models #1532

Merged
merged 43 commits into from
Sep 26, 2024
Merged

1520 new hp models #1532

merged 43 commits into from
Sep 26, 2024

Conversation

FWuellhorst
Copy link
Contributor

@FWuellhorst FWuellhorst commented Aug 19, 2024

Closes #1520
Closes #1531 (with c216e97)
Closes #1507
Closes #1128
Closes #1347
Closes #1462
Closes #1128

@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/1520_newHPModels/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!

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.

@MZuschlag
As discussed briefly already, I moved the old models to obsolete and adjusted the old performance data to the new format. This PR seems huge, but it is mainly moving the HeatPump, Chiller, and HeatPumpSystem to obsolete. Please check if the old examples still work for you (Obsolete is still tested in CI, so nothing changed) and if the new models, especially AixLib.Fluid.HeatPumps.ModularReversible.RefrigerantCycle.TableData3D is clear and useable. This was not yet reviewed in IBPSA.
If you have questions about the new approach and how to adopt your modules to it, we can also schedule a meeting.

Copy link

@MZuschlag MZuschlag left a comment

Choose a reason for hiding this comment

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

See my comments

MZuschlag
MZuschlag previously approved these changes Sep 20, 2024
Copy link

@MZuschlag MZuschlag left a comment

Choose a reason for hiding this comment

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

Mostly general question adressing heat pump modeling in general.

@ebc-aixlib-bot
Copy link
Contributor

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

@ebc-aixlib-bot
Copy link
Contributor

Reference results have been displayed graphically and are created under the following page https://rwth-ebc.github.io/AixLib/1520_newHPModels/charts

…ion reference files. Please pull the new files before push again. Plottet Results /1520_newHPModels/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/1520_newHPModels/charts

@ebc-aixlib-bot
Copy link
Contributor

Reference results have been displayed graphically and are created under the following page https://rwth-ebc.github.io/AixLib/1520_newHPModels/charts

…ion reference files. Please pull the new files before push again. Plottet Results /1520_newHPModels/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/1520_newHPModels/charts

@ebc-aixlib-bot
Copy link
Contributor

Reference results have been displayed graphically and are created under the following page https://rwth-ebc.github.io/AixLib/1520_newHPModels/charts

DaJansenGit and others added 3 commits September 25, 2024 09:39
…ion reference files. Please pull the new files before push again. Plottet Results /1520_newHPModels/charts/
@FWuellhorst FWuellhorst merged commit aa7a87f into main Sep 26, 2024
1 check passed
@FWuellhorst FWuellhorst deleted the 1520_newHPModels branch September 26, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment