AixLib icon indicating copy to clipboard operation
AixLib copied to clipboard

Changed TStart for BufferStorage and Storage to an array

Open tobinfiedler opened this issue 2 years ago • 3 comments

Also changed the examples for BufferStorage. The changes in Storage are not testet yet.

Thank you for making a Pull Request to AixLib!

Please consider these points before submitting:

  • Mention the issue that this Pull Request intends to solve, and briefly describe what the main changes are.
  • Make sure all new code follows our Modelica Guidelines
  • Make sure all new models include documentation as described in the Documentation Wiki-Page and are demonstrated by suitable examples

If you know someone who could review your code, please use the Reviewer function on the right to ask for a review and also assign the PR to them. If not, no worries, we will find someone for you.

Thanks again for your PR! You can delete these first lines before submitting your PR.

tobinfiedler avatar Jul 14 '22 15:07 tobinfiedler

@tobinfiedler reminder

tosch4 avatar Oct 12 '22 14:10 tosch4

@tobinfiedler, @tosch4, any updates on this?

FelixStege avatar Feb 13 '23 13:02 FelixStege

@LauraMaier : I added the requested changes and triggered the CI to see if the result changes as expected. I will update the failing CI ones the plot confirms the correct implementation. Please check my others comments and re-review.

FWuellhorst avatar Sep 19 '23 13:09 FWuellhorst

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/issue1224_initial_layer_values_storage/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!

ebc-aixlib-bot avatar Jul 18 '24 13:07 ebc-aixlib-bot

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

ebc-aixlib-bot avatar Jul 19 '24 08:07 ebc-aixlib-bot

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

ebc-aixlib-bot avatar Jul 19 '24 08:07 ebc-aixlib-bot