ebc-aixlib-bot
commented
2 months ago 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.Waterdirectly. - Never using absolute paths to files (e.g.,
C:orD:). Replace them withmodelica://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
Closes #78