Skip to content

Issue1223 new storage examples #1307

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

Merged
merged 80 commits into from
Jul 26, 2024
Merged

Issue1223 new storage examples #1307

merged 80 commits into from
Jul 26, 2024

Conversation

LauraMaier
Copy link
Contributor

This closes #1223

@LauraMaier LauraMaier requested a review from MZuschlag July 14, 2022 15:16
@LauraMaier LauraMaier self-assigned this Jul 14, 2022
@tosch4
Copy link
Contributor

tosch4 commented Oct 12, 2022

@LauraMaier
please check feedback from Moritz

@LauraMaier LauraMaier requested a review from MZuschlag October 12, 2022 21:12
@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page
https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

@LauraMaier LauraMaier requested review from FWuellhorst and removed request for MZuschlag October 14, 2022 18:07
@LauraMaier
Copy link
Contributor Author

I removed the review request from @MZuschlag to speed up the process now even though the review so far was very helpful! :-)

@ebc-aixlib-bot
Copy link
Contributor

Errors in regression test. Compare the results on the following page
https://ebc.pages.rwth-aachen.de/EBC_all/github_ci/AixLib/issue1223_NewStorageExamples/plots

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.

@LauraMaier You somehow deleted the renamed files instead of renaming them. Please change this to keep the file history intact.

FWuellhorst
FWuellhorst previously approved these changes Nov 18, 2022
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 local rename does not work for me. I guess one has to do it directly in the correct way, as git already had a history on StorageDetailedBaseDataDefinition now.
But I mean it's not that important!
Thanks for your work. Now let's wait for HTML

@FWuellhorst FWuellhorst changed the base branch from main to issue1224_initial_layer_values_storage July 19, 2024 11:49
FWuellhorst and others added 2 commits July 19, 2024 14:20
…ion reference files. Please pull the new files before push again. Plottet Results /issue1223_NewStorageExamples/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/issue1223_NewStorageExamples/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!

Base automatically changed from issue1224_initial_layer_values_storage to main July 19, 2024 14:57
@FWuellhorst FWuellhorst merged commit 9eca742 into main Jul 26, 2024
1 check passed
@FWuellhorst FWuellhorst deleted the issue1223_NewStorageExamples branch July 26, 2024 07:44
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.

Add examples for StorageDetailed and StorageSimple models
6 participants