123 bes rules #127

FWuellhorst · 2025-12-23T16:36:41Z

Closes #123

…to 123_bes-rules

ebc-aixlib-bot · 2025-12-23T16:51:29Z

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/123_bes-rules/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!

HvanderStok

Thanks for making it public. I looked mostly over the aspects I use in my work and the examples. It would be nice if all examples were working. But mostly everything else looks good from my site.

BESMod/BESRules/BaseClasses/PartialHeatPumpDesign2D.mo

HvanderStok · 2025-12-24T08:34:17Z

BESMod/BESRules/DesignOptimization/ExamplesInModelica/VitoCal250.mo

+    userProfiles(
+      fileNameIntGains=Modelica.Utilities.Files.loadResource(
+          "D:/00_temp/01_bes_rules/UseCase_TBivAndV/influence_user/data/InternalGainsHoliday.txt"),
+      gain={1,1,1},
+      use_TSetFile=true,
+      fileNameTSet=Modelica.Utilities.Files.loadResource(
+          "D:/00_temp/01_bes_rules/UseCase_TBivAndV/influence_user/data/TSetHoliday.txt"),
+      use_absIntGai=false));


Can you add these to the Resources or remove them here? Then this example is running.

HvanderStok · 2025-12-24T08:51:11Z

BESMod/BESRules/PVAndHPDesignAndControlOptimization/BaseAPI.mo

All the models in PVAndHPDesignAndControl Optimization are not needed anymore, or are they? Remove them or add package.mo and add the package to the BESRules package.order.

BESMod/BESRules/DesignOptimization/MonoenergeticOptiHorst.mo

HvanderStok · 2025-12-24T09:06:27Z

BESMod/BESRules/DesignOptimization/ExamplesInModelica/OptiHorst4D.mo

Even if I fix the wrong path in MonoenergeticOptiHorst is not translating with the following error:
Failed to generate code for an algebraic loop
involving when equations or algorithms with when parts.
Unknowns:
hydraulic.generation.defCtrl.and1.u1
hydraulic.generation.defCtrl.andDefrost.y
hydraulic.generation.defCtrl.greater.u2
hydraulic.generation.defCtrl.greater.y
hydraulic.generation.defCtrl.orDef.y
hydraulic.generation.defCtrl.timer.entryTime
hydraulic.generation.defCtrl.timer.u
hydraulic.generation.defCtrl.timer.y
hydraulic.generation.heatPump.hys.y
hydraulic.generation.heatPump.refCyc.refCycHeaPumHea.nDTabQUse_flow.u[1]
hydraulic.generation.heatPump.refCyc.swiQEva.u2
hydraulic.generation.heatPump.safCtr.andCanOpe.u[1]
hydraulic.generation.heatPump.safCtr.swiErr.u2

Equations:
when hydraulic.generation.defCtrl.timer.u then
hydraulic.generation.defCtrl.timer.entryTime = time;
end when;
hydraulic.generation.defCtrl.timer.y = (if hydraulic.generation.defCtrl.timer.u then time-hydraulic.generation.defCtrl.timer.entryTime else 0.0);
hydraulic.generation.defCtrl.greater.y = hydraulic.generation.defCtrl.greater.u1 > hydraulic.generation.defCtrl.greater.u2;
hydraulic.generation.defCtrl.orDef.y = hydraulic.generation.defCtrl.orDef.u1 or hydraulic.generation.defCtrl.orDef.u2;
hydraulic.generation.defCtrl.and1.y = hydraulic.generation.defCtrl.and1.u1 and hydraulic.generation.defCtrl.and1.u2;
hydraulic.generation.defCtrl.andDefrost.y = hydraulic.generation.defCtrl.andDefrost.u1 and hydraulic.generation.defCtrl.andDefrost.u2;
hydraulic.generation.defCtrl.notHea.y = not hydraulic.generation.defCtrl.notHea.u;
hydraulic.generation.defCtrl.swi.y = (if hydraulic.control.priGenPIDCtrl.isOn then hydraulic.generation.defCtrl.swi.u1 else 1E+60);
hydraulic.generation.defCtrl.andIsOn.y = hydraulic.control.priGenPIDCtrl.isOn and hydraulic.generation.defCtrl.andIsOn.u2;
hydraulic.generation.heatPump.safCtr.swiErr.y = (if hydraulic.generation.heatPump.safCtr.swiErr.u2 then hydraulic.generation.heatPump.safCtr.swiErr.u1 else 0.0);
hydraulic.generation.heatPump.safCtr.andCanOpe.y = Modelica.Math.BooleanVectors.andTrue (hydraulic.generation.heatPump.safCtr.andCanOpe.u);
hydraulic.generation.heatPump.hys.y = not pre(hydraulic.generation.heatPump.hys.y) and hydraulic.generation.heatPump.hys.u > hydraulic.generation.heatPump.hys.uHigh or pre(hydraulic.generation.heatPump.hys.y) and hydraulic.generation.heatPump.hys.u >= 0.001;
hydraulic.generation.heatPump.safCtr.opeEnv.swiHeaCoo.y = (if hydraulic.generation.heatPump.safCtr.opeEnv.swiHeaCoo.u2 then hydraulic.generation.heatPump.safCtr.opeEnv.swiHeaCoo.u1 else hydraulic.generation.heatPump.safCtr.opeEnv.swiHeaCoo.u3);

You may be able to cut the loop
by putting 'pre' around some of the references to
unknown continuous time variables in when parts or when conditions.

Translation aborted.

WARNINGS have been issued.

ERRORS have been issued.

HvanderStok · 2025-12-29T08:28:39Z

bes-rules/tests/test_bayes.py

Should these tests work? They are not running.

HvanderStok · 2025-12-29T08:29:02Z

bes-rules/tests/test_buildings.py

Should these tests work? They are not running.

HvanderStok · 2025-12-29T09:03:24Z

bes-rules/bes_rules/plotting/storage_animation.py

+    INPUT_CONFIG = "TRY2015_541817120824_Jahr_B1918_standard_o0w2r1g0_SingleDwelling_M_0K-Per-IntGai"
+    INPUT_CONFIG = "TRY2045_474856110632_Somm_B2001_standard_o2w2r2g2_SingleDwelling_M_0K-Per-IntGai"
+
+    BASE = RESULTS_FOLDER.joinpath("UseCase_TBivAndV", "influence_heat_transfer_januar", "DesignOptimizationResults")
+    for M in [
+        "HeatTransferOnlyConduction",
+        "HeatTransferLambdaEffSmooth",
+        "HeatTransferBuoyancyWetter",
+    ]:
+        for N in ["_NLayer", ""]:
+            for STO in [0, 3]:
+                for SCALE in [False, True]:
+                    map_besmod_to_plot_function(
+                        mat_file=BASE.joinpath(f"{INPUT_CONFIG}_{M}{N}", f"iterate_{STO}.mat"),


How are these results generated?

HvanderStok · 2025-12-29T10:14:05Z

bes-rules/examples/practical_design_rules/base_design_optimization.py

+    buildings_per_year = boundary_conditions.building.get_all_tabula_sfh_buildings(as_dict=True)
+    if years_of_construction is None:
+        years_of_construction = buildings_per_year.keys()
+    buildings_to_simulate = [
+        buildings_per_year[f"{year}_standard"] for year in years_of_construction
+    ]


When the dict buildings_per_year is used as in compare_onoff an error occurs because the keys already include "_standard".

HvanderStok · 2025-12-29T10:52:35Z

bes-rules/examples/practical_design_rules/influence_mpc.py

I get the following error here:

pydantic_core._pydantic_core.ValidationError: 3 validation errors for configuration of agent 'mpc' / module 'mpc': enable_deactivate_mpc Input should be a valid Field name. Field 'enable_deactivate_mpc' does not exist. Did you mean any of ['states', 'time_step', 'type', 'module_id', 'validate_incoming_values']? [type=literal_error, input_value=True, input_type=bool] For further information visit https://errors.pydantic.dev/2.12/v/literal_error control_values_when_deactivated Input should be a valid Field name. Field 'control_values_when_deactivated' does not exist. Did you mean any of ['controls', 'states', 'type', 'time_step', 'validate_incoming_values']? [type=literal_error, input_value={'TBufSet': 303.15, 'yVal... 'actExtBufCtrl': False}, input_type=dict] For further information visit https://errors.pydantic.dev/2.12/v/literal_error outputs_to_send_when_activated Input should be a valid Field name. Field 'outputs_to_send_when_activated' does not exist. Did you mean any of ['outputs', 'set_outputs', 'inputs', 'states', 'type']? [type=literal_error, input_value={'actExtVal': True, 'actE..., 'actExtBufCtrl': True}, input_type=dict] For further information visit https://errors.pydantic.dev/2.12/v/literal_error

FWuellhorst and others added 12 commits December 9, 2025 16:13

add bes-rules

957ddfb

move mpc files

98bfff9

chore

162ec10

adjust users

c313b27

chore

b254b06

Add description for installation

2da7cc5

chore

d3067e6

Merge branch '123_bes-rules' of https://github.com/RWTH-EBC/BESMod in…

c4e365d

…to 123_bes-rules

fix path

26a3e5c

use latest aixlib commit

fef6f53

rm old files and import

e28a6c4

use final aixlib commit

8131a55

FWuellhorst requested review from FelixStege, HvanderStok and TobiasSpratte December 23, 2025 16:36

Merge branch 'main' into 123_bes-rules

900e17c

HvanderStok requested changes Dec 29, 2025

View reviewed changes

HvanderStok added 6 commits January 5, 2026 15:29

remove comment

6530e94

fix wrong model path

05d5fff

add extend example package

eff8685

fix user modelica modifier

9f36b2a

set default of modify_transfer_system to False

9778d50

add default VARIABLE_NAMES to the input analysis

6639901

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

123 bes rules #127

123 bes rules #127

Uh oh!

FWuellhorst commented Dec 23, 2025

Uh oh!

ebc-aixlib-bot commented Dec 23, 2025

Uh oh!

HvanderStok left a comment

Uh oh!

Uh oh!

HvanderStok Dec 24, 2025

Uh oh!

HvanderStok Dec 24, 2025

Uh oh!

Uh oh!

HvanderStok Dec 24, 2025

Uh oh!

HvanderStok Dec 29, 2025

Uh oh!

HvanderStok Dec 29, 2025

Uh oh!

HvanderStok Dec 29, 2025

Uh oh!

HvanderStok Dec 29, 2025

Uh oh!

HvanderStok Dec 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

123 bes rules #127

Are you sure you want to change the base?

123 bes rules #127

Uh oh!

Conversation

FWuellhorst commented Dec 23, 2025

Uh oh!

ebc-aixlib-bot commented Dec 23, 2025

Uh oh!

HvanderStok left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants