rtc-tools 2.9.0a1__tar.gz → 2.9.0a3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (476) hide show
  1. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.github/workflows/ci.yml +29 -2
  2. rtc_tools-2.9.0a3/CODEOWNERS +39 -0
  3. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/CONTRIBUTING.md +28 -0
  4. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/PKG-INFO +2 -2
  5. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/cascading_channels.rst +1 -2
  6. rtc_tools-2.9.0a3/doc/examples/optimization/debugging.rst +90 -0
  7. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/goal_programming.rst +7 -7
  8. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/integrator_delay.rst +1 -1
  9. rtc_tools-2.9.0a3/doc/examples/optimization/linearised_SV.rst +239 -0
  10. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/lookup_table.rst +5 -5
  11. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/mixed_integer.rst +1 -1
  12. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/pumped_hydropower_system.rst +2 -2
  13. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization.rst +1 -0
  14. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/ensemble_results.py +4 -4
  15. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/simulation/custom_equation.rst +1 -1
  16. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/simulation/setpoint.rst +1 -1
  17. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/getting-started.rst +2 -2
  18. rtc_tools-2.9.0a3/doc/images/discretization_2nodes.png +0 -0
  19. rtc_tools-2.9.0a3/doc/images/discretization_3nodes.png +0 -0
  20. rtc_tools-2.9.0a3/doc/images/initialization/Figure_give.png +0 -0
  21. rtc_tools-2.9.0a3/doc/images/initialization/Figure_st100q.png +0 -0
  22. rtc_tools-2.9.0a3/doc/images/initialization/steady5h.png +0 -0
  23. rtc_tools-2.9.0a3/doc/images/staggered_grid_3.png +0 -0
  24. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/simulation/basics.rst +1 -1
  25. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/model/Example.mo +11 -7
  26. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/model/Example.mo +5 -3
  27. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/src/example.py +7 -1
  28. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/model/Example.mo +4 -2
  29. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/model/ExampleOptimization.mo +5 -2
  30. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/src/steady_state_initialization_mixin.py +6 -1
  31. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/goal_programming/model/Example.mo +8 -4
  32. rtc_tools-2.9.0a3/examples/goal_programming/reference_output/timeseries_export.csv +22 -0
  33. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/goal_programming/src/example.py +2 -1
  34. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/mixed_integer/model/Example.mo +8 -4
  35. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/step_response/model/Example.mo +5 -3
  36. rtc_tools-2.9.0a3/examples/step_response/reference_output/timeseries_export_saint_venant.csv +192 -0
  37. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/pyproject.toml +1 -1
  38. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/casadi_helpers.py +0 -11
  39. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/casadi_to_lp.py +54 -19
  40. rtc_tools-2.9.0a3/src/rtctools/_internal/modelica_mixin_base.py +230 -0
  41. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/interpolation/bspline1d.py +2 -4
  42. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/netcdf.py +1 -1
  43. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/rtc.py +1 -1
  44. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/collocated_integrated_optimization_problem.py +311 -213
  45. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/goal_programming_mixin.py +14 -24
  46. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/goal_programming_mixin_base.py +59 -18
  47. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/linearized_order_goal_programming_mixin.py +1 -1
  48. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/min_abs_goal_programming_mixin.py +10 -8
  49. rtc_tools-2.9.0a3/src/rtctools/optimization/modelica_mixin.py +323 -0
  50. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/optimization_problem.py +45 -13
  51. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/single_pass_goal_programming_mixin.py +18 -17
  52. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/simulation/csv_mixin.py +1 -1
  53. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/simulation/simulation_problem.py +56 -213
  54. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/examples/test_examples.py +4 -2
  55. rtc_tools-2.9.0a3/tests/modelica/install_msl.mos +4 -0
  56. rtc_tools-2.9.0a3/tests/modelica/test_omc_conformance.py +262 -0
  57. rtc_tools-2.9.0a3/tests/optimization/data/ModelDelayConstantInput.mo +6 -0
  58. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/SingleShootingModel.mo +2 -0
  59. rtc_tools-2.9.0a3/tests/optimization/data/initial_state.csv +2 -0
  60. rtc_tools-2.9.0a3/tests/optimization/data/member0/initial_state.csv +2 -0
  61. rtc_tools-2.9.0a3/tests/optimization/data/member1/initial_state.csv +2 -0
  62. rtc_tools-2.9.0a3/tests/optimization/data/one-member-ensemble/member0/initial_state.csv +2 -0
  63. rtc_tools-2.9.0a3/tests/optimization/test_constraint_names.py +179 -0
  64. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_delay_expressions.py +52 -0
  65. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_export_lp.py +135 -6
  66. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_integration.py +48 -0
  67. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_interpolation.py +21 -0
  68. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_modelica_mixin.py +85 -0
  69. rtc_tools-2.9.0a3/tests/optimization/test_scaling.py +83 -0
  70. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_vector_constraints_variables.py +13 -0
  71. rtc_tools-2.9.0a3/tests/simulation/__init__.py +0 -0
  72. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/test_simulation.py +69 -0
  73. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tox.ini +5 -1
  74. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/uv.lock +12 -5
  75. rtc_tools-2.9.0a1/doc/examples/optimization/debugging.rst +0 -51
  76. rtc_tools-2.9.0a1/examples/goal_programming/reference_output/timeseries_export.csv +0 -22
  77. rtc_tools-2.9.0a1/examples/step_response/reference_output/timeseries_export_saint_venant.csv +0 -192
  78. rtc_tools-2.9.0a1/src/rtctools/optimization/modelica_mixin.py +0 -484
  79. rtc_tools-2.9.0a1/tests/optimization/data/member0/initial_state.csv +0 -2
  80. rtc_tools-2.9.0a1/tests/optimization/data/member1/initial_state.csv +0 -2
  81. rtc_tools-2.9.0a1/tests/optimization/data/one-member-ensemble/member0/initial_state.csv +0 -2
  82. rtc_tools-2.9.0a1/tests/simulation/data/initial_state.csv +0 -2
  83. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.codecov.yml +0 -0
  84. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.coveragerc +0 -0
  85. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.git-blame-ignore-revs +0 -0
  86. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.github/actions/setup-python/action.yml +0 -0
  87. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.gitignore +0 -0
  88. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.pre-commit-config.yaml +0 -0
  89. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/.readthedocs.yaml +0 -0
  90. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/AUTHORS +0 -0
  91. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/CHARTER.md +0 -0
  92. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/CODE_OF_CONDUCT.md +0 -0
  93. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/COPYING +0 -0
  94. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/COPYING.LESSER +0 -0
  95. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/GOVERNANCE.md +0 -0
  96. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/README.md +0 -0
  97. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/.gitignore +0 -0
  98. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/Makefile +0 -0
  99. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/_static/external_links.js +0 -0
  100. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/_static/theme_overrides.css +0 -0
  101. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/conf.py +0 -0
  102. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/basic.rst +0 -0
  103. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/channel_pulse.rst +0 -0
  104. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/channel_wave_damping.rst +0 -0
  105. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/ensemble.rst +0 -0
  106. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/fallback_options.rst +0 -0
  107. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/optimization/step_response.rst +0 -0
  108. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/basic_results.py +0 -0
  109. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/cascading_channels_results.py +0 -0
  110. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/channel_pulse_results.py +0 -0
  111. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/channel_wave_damping.py +0 -0
  112. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/goal_programming_results.py +0 -0
  113. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/integrator_delay.py +0 -0
  114. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/lookup_table_results.py +0 -0
  115. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/mixed_integer_results.py +0 -0
  116. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/pumped_hydropower_system_results.py +0 -0
  117. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/pyplots/simulation_results.py +0 -0
  118. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples/simulation.rst +0 -0
  119. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/examples.rst +0 -0
  120. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/Aggregation_01.png +0 -0
  121. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/Lake-Hartwell-24012016.jpg +0 -0
  122. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/PumpedStoragePlant_openmodelica.png +0 -0
  123. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/Woudagemaal.jpg +0 -0
  124. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/basic_example_console.png +0 -0
  125. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/cascading_channels_omedit.png +0 -0
  126. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/channel_impulse_xs.png +0 -0
  127. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/channel_wave_damping_omedit.png +0 -0
  128. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/graig-coch-2117306_640.jpg +0 -0
  129. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/integrator_delay_modelica.png +0 -0
  130. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/lavant-2976738_1280.jpg +0 -0
  131. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/orifice_vs_pump_openmodelica.png +0 -0
  132. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/pont-du-gard-1742029_1280.jpg +0 -0
  133. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/rtc-tools-horizontal-color.svg +0 -0
  134. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/rtc-tools-horizontal-white.svg +0 -0
  135. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/simple_storage_openmodelica.png +0 -0
  136. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/single_channel.png +0 -0
  137. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/single_channel_hec-ras.png +0 -0
  138. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/validation/Downstream_150.png +0 -0
  139. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/images/validation/Upstream_150.png +0 -0
  140. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/index.rst +0 -0
  141. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/literature.bib +0 -0
  142. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/make.bat +0 -0
  143. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/basics.rst +0 -0
  144. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/csv_io.rst +0 -0
  145. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/fews_io.rst +0 -0
  146. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/forecast_uncertainty.rst +0 -0
  147. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/goal_programming/converting_goals_to_constraints.rst +0 -0
  148. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/goal_programming/goals.rst +0 -0
  149. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/goal_programming/linearized_order.rst +0 -0
  150. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/goal_programming/main_idea.rst +0 -0
  151. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/goal_programming/minimize_absolute_value.rst +0 -0
  152. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/homotopy.rst +0 -0
  153. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/initial_state_estimation.rst +0 -0
  154. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/linearization.rst +0 -0
  155. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/lookup_tables.rst +0 -0
  156. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/modelica_models.rst +0 -0
  157. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/multi_objective.rst +0 -0
  158. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/solver_configuration.rst +0 -0
  159. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization/time_discretization.rst +0 -0
  160. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/optimization.rst +0 -0
  161. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/related-projects.rst +0 -0
  162. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/simulation/csv_io.rst +0 -0
  163. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/simulation/fews_io.rst +0 -0
  164. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/simulation.rst +0 -0
  165. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/doc/time-series.rst +0 -0
  166. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/basic/input/initial_state.csv +0 -0
  167. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/basic/input/timeseries_import.csv +0 -0
  168. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/basic/model/Example.mo +0 -0
  169. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/basic/output/.gitignore +0 -0
  170. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/basic/reference_output/timeseries_export.csv +0 -0
  171. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/basic/src/example.py +0 -0
  172. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/input/initial_state.csv +0 -0
  173. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/input/timeseries_import.csv +0 -0
  174. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/model/.gitignore +0 -0
  175. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/output/.gitignore +0 -0
  176. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/reference_output/timeseries_export.csv +0 -0
  177. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/cascading_channels/src/example.py +0 -0
  178. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/HEC-RAS.zip +0 -0
  179. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/input/timeseries_import.csv +0 -0
  180. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/output/.gitignore +0 -0
  181. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/reference_output/HEC-RAS_export.csv +0 -0
  182. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/reference_output/timeseries_export.csv +0 -0
  183. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/reference_output/timeseries_export_inertial_wave.csv +0 -0
  184. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/reference_output/timeseries_export_inertial_wave_semi_implicit.csv +0 -0
  185. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/reference_output/timeseries_export_saint_venant.csv +0 -0
  186. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_pulse/reference_output/timeseries_export_saint_venant_upwind.csv +0 -0
  187. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/input/timeseries_import.csv +0 -0
  188. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/model/ExampleLocalControl.mo +0 -0
  189. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/model/PIDController.mo +0 -0
  190. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/output/.gitignore +0 -0
  191. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/reference_output/timeseries_export.csv +0 -0
  192. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/reference_output/timeseries_export_local_control.csv +0 -0
  193. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/src/example_local_control.py +0 -0
  194. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/src/example_optimization.py +0 -0
  195. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/channel_wave_damping/src/step_size_parameter_mixin.py +0 -0
  196. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/.gitignore +0 -0
  197. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/ensemble.csv +0 -0
  198. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/forecast1/.gitignore +0 -0
  199. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/forecast1/initial_state.csv +0 -0
  200. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/forecast1/timeseries_import.csv +0 -0
  201. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/forecast2/.gitignore +0 -0
  202. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/forecast2/initial_state.csv +0 -0
  203. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/forecast2/timeseries_import.csv +0 -0
  204. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/lookup_tables/.gitignore +0 -0
  205. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/lookup_tables/curvefit_options.ini +0 -0
  206. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/input/lookup_tables/storage_V.csv +0 -0
  207. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/model/Example.mo +0 -0
  208. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/output/forecast1/.gitignore +0 -0
  209. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/output/forecast2/.gitignore +0 -0
  210. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/reference_output/forecast1/timeseries_export.csv +0 -0
  211. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/reference_output/forecast2/timeseries_export.csv +0 -0
  212. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/ensemble/src/example.py +0 -0
  213. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/fallback_option/output/.gitignore +0 -0
  214. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/fallback_option/src/example.py +0 -0
  215. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/fallback_option/src/example_with_gp.py +0 -0
  216. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/goal_programming/input/initial_state.csv +0 -0
  217. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/goal_programming/input/timeseries_import.csv +0 -0
  218. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/goal_programming/output/.gitignore +0 -0
  219. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/integrator_delay/input/initial_state.csv +0 -0
  220. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/integrator_delay/input/timeseries_import.csv +0 -0
  221. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/integrator_delay/input/timeseries_import_simulation.csv +0 -0
  222. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/integrator_delay/model/Example.mo +0 -0
  223. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/integrator_delay/src/example.py +0 -0
  224. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/input/.gitignore +0 -0
  225. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/input/initial_state.csv +0 -0
  226. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/input/lookup_tables/.gitignore +0 -0
  227. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/input/lookup_tables/curvefit_options.ini +0 -0
  228. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/input/lookup_tables/storage_V.csv +0 -0
  229. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/input/timeseries_import.csv +0 -0
  230. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/model/Example.mo +0 -0
  231. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/output/.gitignore +0 -0
  232. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/reference_output/timeseries_export.csv +0 -0
  233. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/lookup_table/src/example.py +0 -0
  234. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/mixed_integer/input/initial_state.csv +0 -0
  235. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/mixed_integer/input/timeseries_import.csv +0 -0
  236. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/mixed_integer/output/.gitignore +0 -0
  237. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/mixed_integer/reference_output/timeseries_export.csv +0 -0
  238. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/mixed_integer/src/example.py +0 -0
  239. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/pumped_hydropower_system/input/initial_state.csv +0 -0
  240. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/pumped_hydropower_system/input/timeseries_import.csv +0 -0
  241. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/pumped_hydropower_system/model/PumpedStoragePlant.mo +0 -0
  242. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/pumped_hydropower_system/output/.gitignore +0 -0
  243. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/pumped_hydropower_system/reference_output/timeseries_export.csv +0 -0
  244. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/pumped_hydropower_system/src/example.py +0 -0
  245. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation/input/parameters.csv +0 -0
  246. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation/input/timeseries_import.csv +0 -0
  247. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation/model/Example.mo +0 -0
  248. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation/output/.gitignore +0 -0
  249. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation/reference_output/timeseries_export.csv +0 -0
  250. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation/src/example.py +0 -0
  251. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation_with_custom_equations/input/initial_state.csv +0 -0
  252. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation_with_custom_equations/input/timeseries_import.csv +0 -0
  253. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation_with_custom_equations/model/SimpleModel.mo +0 -0
  254. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation_with_custom_equations/output/.gitignore +0 -0
  255. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation_with_custom_equations/reference_output/timeseries_export.csv +0 -0
  256. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/simulation_with_custom_equations/src/simple_model.py +0 -0
  257. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/single_reservoir/input/initial_state.csv +0 -0
  258. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/single_reservoir/input/timeseries_import.csv +0 -0
  259. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/single_reservoir/model/single_reservoir.mo +0 -0
  260. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/single_reservoir/output/.gitignore +0 -0
  261. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/single_reservoir/reference_output/timeseries_export.csv +0 -0
  262. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/single_reservoir/src/single_reservoir.py +0 -0
  263. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/step_response/input/initial_state.csv +0 -0
  264. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/step_response/input/timeseries_import.csv +0 -0
  265. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/step_response/output/.gitignore +0 -0
  266. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/examples/step_response/src/example.py +0 -0
  267. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/sonar-project.properties +0 -0
  268. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/__init__.py +0 -0
  269. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/__init__.py +0 -0
  270. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/alias_tools.py +0 -0
  271. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/caching.py +0 -0
  272. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/debug_check_helpers.py +0 -0
  273. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/_internal/ensemble_bounds_decorator.py +0 -0
  274. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/__init__.py +0 -0
  275. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/csv.py +0 -0
  276. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/interpolation/__init__.py +0 -0
  277. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/interpolation/bspline.py +0 -0
  278. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/interpolation/bspline2d.py +0 -0
  279. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/pi.py +0 -0
  280. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/data/storage.py +0 -0
  281. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/__init__.py +0 -0
  282. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/control_tree_mixin.py +0 -0
  283. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/csv_lookup_table_mixin.py +0 -0
  284. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/csv_mixin.py +0 -0
  285. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/homotopy_mixin.py +0 -0
  286. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/initial_state_estimation_mixin.py +0 -0
  287. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/io_mixin.py +0 -0
  288. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/linearization_mixin.py +0 -0
  289. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/netcdf_mixin.py +0 -0
  290. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/pi_mixin.py +0 -0
  291. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/planning_mixin.py +0 -0
  292. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/optimization/timeseries.py +0 -0
  293. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/rtctoolsapp.py +0 -0
  294. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/simulation/__init__.py +0 -0
  295. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/simulation/io_mixin.py +0 -0
  296. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/simulation/pi_mixin.py +0 -0
  297. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/util.py +0 -0
  298. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/src/rtctools/version.py +0 -0
  299. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/__init__.py +0 -0
  300. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/__init__.py +0 -0
  301. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/.gitignore +0 -0
  302. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/curve.dat +0 -0
  303. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/diag.xml +0 -0
  304. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/initial_state_0.csv +0 -0
  305. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/initial_state_1.csv +0 -0
  306. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/look_up_table_0.csv +0 -0
  307. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/look_up_table_1.csv +0 -0
  308. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/look_up_table_2.csv +0 -0
  309. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/pi_run.xml +0 -0
  310. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/rtcDataConfig.xml +0 -0
  311. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/rtcParameterConfig.xml +0 -0
  312. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/surface.dat +0 -0
  313. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_export.xml +0 -0
  314. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import.bin +0 -0
  315. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import.xml +0 -0
  316. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_0.csv +0 -0
  317. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_1.csv +0 -0
  318. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_2.csv +0 -0
  319. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_ensemble.nc +0 -0
  320. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_ensemble.xml +0 -0
  321. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_ensemblesize1_noRealization.nc +0 -0
  322. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_ensemblesize1_withRealization.nc +0 -0
  323. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data/timeseries_import_neq.xml +0 -0
  324. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/data_path.py +0 -0
  325. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/test_csv.py +0 -0
  326. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/test_data.py +0 -0
  327. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/test_diag.py +0 -0
  328. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/test_interpolate.py +0 -0
  329. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/test_netcdf.py +0 -0
  330. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data/test_storage.py +0 -0
  331. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/data_path.py +0 -0
  332. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/examples/__init__.py +0 -0
  333. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/internal/__init__.py +0 -0
  334. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/internal/test_alias_tools.py +0 -0
  335. {rtc_tools-2.9.0a1/tests/optimization → rtc_tools-2.9.0a3/tests/modelica}/__init__.py +0 -0
  336. {rtc_tools-2.9.0a1/tests/simulation → rtc_tools-2.9.0a3/tests/optimization}/__init__.py +0 -0
  337. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/.gitignore +0 -0
  338. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/EmptyModel.mo +0 -0
  339. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/Model.mo +0 -0
  340. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelAlgebraic.mo +0 -0
  341. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelDebugChecks.mo +0 -0
  342. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelDelay.mo +0 -0
  343. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelDelayLoop.mo +0 -0
  344. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelHomotopyInput.mo +0 -0
  345. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelHomotopyInputAlias.mo +0 -0
  346. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelHomotopyParameter.mo +0 -0
  347. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelMixedInteger.mo +0 -0
  348. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelNestedDelay.mo +0 -0
  349. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelSIUnits.mo +0 -0
  350. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelSymbolicParameters.mo +0 -0
  351. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelWithInitial.mo +0 -0
  352. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelWithInitialLinear.mo +0 -0
  353. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ModelWithLookupTable.mo +0 -0
  354. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/ensemble.csv +0 -0
  355. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/lookup_tables/.gitignore +0 -0
  356. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/lookup_tables/curvefit_options.ini +0 -0
  357. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/lookup_tables/x_prime.csv +0 -0
  358. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/member0/.gitignore +0 -0
  359. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/member0/parameters.csv +0 -0
  360. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/member0/timeseries_import.csv +0 -0
  361. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/member1/.gitignore +0 -0
  362. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/member1/parameters.csv +0 -0
  363. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/member1/timeseries_import.csv +0 -0
  364. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/.gitignore +0 -0
  365. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/Model.mo +0 -0
  366. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/ensemble.csv +0 -0
  367. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/member0/timeseries_import.csv +0 -0
  368. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/member1/timeseries_import.csv +0 -0
  369. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/member2/timeseries_import.csv +0 -0
  370. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/member3/timeseries_import.csv +0 -0
  371. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/rtcDataConfig.xml +0 -0
  372. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/rtcParameterConfig.xml +0 -0
  373. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/timeseries_import.nc +0 -0
  374. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_ensemble_sizes/timeseries_import.xml +0 -0
  375. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/ensemble.csv +0 -0
  376. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/member0/timeseries_import.csv +0 -0
  377. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/member1/timeseries_import.csv +0 -0
  378. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/rtcDataConfig.xml +0 -0
  379. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/rtcParameterConfig.xml +0 -0
  380. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/timeseries_import.nc +0 -0
  381. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_initial_date/timeseries_import.xml +0 -0
  382. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/ensemble.csv +0 -0
  383. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/member0/timeseries_import.csv +0 -0
  384. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/member1/timeseries_import.csv +0 -0
  385. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/rtcDataConfig.xml +0 -0
  386. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/rtcParameterConfig.xml +0 -0
  387. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/timeseries_import.nc +0 -0
  388. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_timestep/timeseries_import.xml +0 -0
  389. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/ensemble.csv +0 -0
  390. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/member0/parameters.csv +0 -0
  391. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/member0/timeseries_import.csv +0 -0
  392. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/member1/parameters.csv +0 -0
  393. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/member1/timeseries_import.csv +0 -0
  394. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/rtcDataConfig.xml +0 -0
  395. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/rtcParameterConfig.xml +0 -0
  396. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/timeseries_import.nc +0 -0
  397. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/multiple_io_mixins/different_values/timeseries_import.xml +0 -0
  398. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/non_zero_indexed_ensembles/Model.mo +0 -0
  399. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/non_zero_indexed_ensembles/rtcDataConfig.xml +0 -0
  400. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/non_zero_indexed_ensembles/rtcParameterConfig.xml +0 -0
  401. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/non_zero_indexed_ensembles/rtcParameterConfig_extra.xml +0 -0
  402. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/non_zero_indexed_ensembles/timeseries_import.xml +0 -0
  403. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/one-member-ensemble/ensemble.csv +0 -0
  404. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/one-member-ensemble/member0/.gitignore +0 -0
  405. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/one-member-ensemble/member0/parameters.csv +0 -0
  406. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/one-member-ensemble/member0/timeseries_import.csv +0 -0
  407. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/parameters.csv +0 -0
  408. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/reference_linear_model.lp +0 -0
  409. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/rtcDataConfig.xml +0 -0
  410. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/rtcParameterConfig.xml +0 -0
  411. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/rtcParameterConfig_extra.xml +0 -0
  412. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/single_non_zero_ensemble_index/Model.mo +0 -0
  413. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/single_non_zero_ensemble_index/rtcDataConfig.xml +0 -0
  414. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/single_non_zero_ensemble_index/rtcParameterConfig.xml +0 -0
  415. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/single_non_zero_ensemble_index/rtcParameterConfig_extra.xml +0 -0
  416. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/single_non_zero_ensemble_index/timeseries_import.xml +0 -0
  417. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/timeseries_import.csv +0 -0
  418. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/timeseries_import.nc +0 -0
  419. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data/timeseries_import.xml +0 -0
  420. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/data_path.py +0 -0
  421. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/regenerate_lp_reference.py +0 -0
  422. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_control_tree_mixin.py +0 -0
  423. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_csv_lookuptable_mixin.py +0 -0
  424. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_csv_mixin.py +0 -0
  425. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_debug_checks.py +0 -0
  426. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_extra_casadipath.py +0 -0
  427. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_goal_programming.py +0 -0
  428. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_homotopy_mixin.py +0 -0
  429. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_io_mixin.py +0 -0
  430. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_linearized_order_goal_programming_mixin.py +0 -0
  431. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_min_abs_goal_programming.py +0 -0
  432. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_multiple_io_mixins.py +0 -0
  433. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_netcdf_mixin.py +0 -0
  434. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_optimization_problem.py +0 -0
  435. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_path_extra_variables.py +0 -0
  436. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_path_variable_assembly.py +0 -0
  437. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_pi_mixin.py +0 -0
  438. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_planning_and_control_tree_mixin.py +0 -0
  439. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_planning_mixin.py +0 -0
  440. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_problem_class_check.py +0 -0
  441. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_single_pass_goal_programming.py +0 -0
  442. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_solvers.py +0 -0
  443. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_timeseries.py +0 -0
  444. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/optimization/test_vector_goals.py +0 -0
  445. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/.gitignore +0 -0
  446. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/Model.mo +0 -0
  447. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/ModelCustomEquation.mo +0 -0
  448. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/Model_base.mo +0 -0
  449. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/Model_delay.mo +0 -0
  450. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/Model_nominal.mo +0 -0
  451. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/initial_state.csv +0 -0
  452. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_infeasible.mo +0 -0
  453. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_out_of_bounds.mo +0 -0
  454. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_out_of_sym_bounds.mo +0 -0
  455. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_with_bounds.mo +0 -0
  456. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_with_input_series.mo +0 -0
  457. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_with_sym_ystart.mo +0 -0
  458. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_with_xstart.mo +0 -0
  459. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/model_with_zero_xstart.mo +0 -0
  460. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/timeseries_import.csv +0 -0
  461. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/infeasible_initial_value/timeseries_import_with_x.csv +0 -0
  462. {rtc_tools-2.9.0a1/tests/optimization → rtc_tools-2.9.0a3/tests/simulation}/data/initial_state.csv +0 -0
  463. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/parameters.csv +0 -0
  464. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/rtcDataConfig.xml +0 -0
  465. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/rtcParameterConfig.xml +0 -0
  466. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/timeseries_import.csv +0 -0
  467. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data/timeseries_import.xml +0 -0
  468. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/data_path.py +0 -0
  469. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/test_csv_mixin.py +0 -0
  470. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/test_io_mixin.py +0 -0
  471. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/test_pi_mixin.py +0 -0
  472. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/simulation/test_problem_class_check.py +0 -0
  473. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/test_case.py +0 -0
  474. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/tests/test_rtctoolsapp.py +0 -0
  475. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/xsd/rtcDataConfig.xsd +0 -0
  476. {rtc_tools-2.9.0a1 → rtc_tools-2.9.0a3}/xsd/rtcSharedTypes.xsd +0 -0
@@ -132,8 +132,35 @@ jobs:
132
132
  dependency-groups: "tests"
133
133
  - run: uv run tox -vv
134
134
 
135
+ # Check example models with OpenModelica, to track models that pymoca
136
+ # accepts but that are not valid Modelica. See tests/modelica.
137
+ modelica-conformance:
138
+ name: Modelica Conformance (OpenModelica ${{ matrix.omc_version }})
139
+ needs: [style]
140
+ runs-on: ubuntu-latest
141
+ strategy:
142
+ matrix:
143
+ # The test records the known failures for this version, and only runs with it.
144
+ omc_version: ['1.27.1']
145
+ container:
146
+ image: openmodelica/openmodelica:v${{ matrix.omc_version }}-ompython
147
+ timeout-minutes: 30
148
+ env:
149
+ TOXENV: omc
150
+ OMC_VERSION: ${{ matrix.omc_version }}
151
+ # The image has no git, so hatch-vcs cannot determine the version.
152
+ SETUPTOOLS_SCM_PRETEND_VERSION: "0+omc"
153
+ steps:
154
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
155
+ - uses: ./.github/actions/setup-python
156
+ with:
157
+ dependency-groups: "tests"
158
+ - name: Install the Modelica Standard Library
159
+ run: omc tests/modelica/install_msl.mos
160
+ - run: uv run tox -vv
161
+
135
162
  deploy:
136
- needs: [build, test-linux, coverage, examples-linux]
163
+ needs: [build, test-linux, coverage, examples-linux, modelica-conformance]
137
164
  runs-on: ubuntu-latest
138
165
  if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/2.') }}
139
166
  permissions:
@@ -150,7 +177,7 @@ jobs:
150
177
  uses: pypa/gh-action-pypi-publish@release/v1
151
178
 
152
179
  deploy-nexus:
153
- needs: [build, test-linux, coverage, examples-linux]
180
+ needs: [build, test-linux, coverage, examples-linux, modelica-conformance]
154
181
  runs-on: ubuntu-latest
155
182
  if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/2.') }}
156
183
  permissions:
@@ -0,0 +1,39 @@
1
+ # Code owners are requested for review on pull requests that change the paths below.
2
+ # For each file, the last matching pattern applies.
3
+ #
4
+ # Current and emeritus committers are listed in CONTRIBUTING.md.
5
+
6
+ # Default
7
+ * @jarsarasty
8
+
9
+ # Core package
10
+ /src/rtctools/_internal/ @jackvreeken @jarsarasty
11
+ /src/rtctools/rtctoolsapp.py @jackvreeken @jarsarasty
12
+ /src/rtctools/util.py @jackvreeken @jarsarasty
13
+ /src/rtctools/version.py @jackvreeken @jarsarasty
14
+ /src/rtctools/data/ @jackvreeken @FaridAlavi @jarsarasty
15
+
16
+ # Optimization
17
+ /src/rtctools/optimization/ @jackvreeken @jbaayen @FaridAlavi @jarsarasty
18
+
19
+ # Simulation
20
+ /src/rtctools/simulation/ @k-horvath-deltares
21
+
22
+ # Tests
23
+ /tests/ @jarsarasty @jackvreeken
24
+
25
+ # Examples
26
+ /examples/ @k-horvath-deltares @FaridAlavi @jarsarasty
27
+
28
+ # Build and dependency configuration
29
+ /pyproject.toml @jackvreeken @jarsarasty
30
+ /tox.ini @jackvreeken @jarsarasty
31
+ /uv.lock @jarsarasty
32
+ /sonar-project.properties @jackvreeken @jarsarasty
33
+
34
+ # CI
35
+ /.github/ @jarsarasty @FaridAlavi @jackvreeken
36
+
37
+ # Documentation
38
+ /doc/ @BernhardBecker @k-horvath-deltares
39
+ /*.md @BernhardBecker @k-horvath-deltares
@@ -3,6 +3,8 @@
3
3
  ## Table of Contents
4
4
 
5
5
  - [Initial Committers](#initial-committers)
6
+ - [Current Committers](#current-committers)
7
+ - [Emeritus Committers](#emeritus-committers)
6
8
  - [Ways to Contribute](#ways-to-contribute)
7
9
  - [Guidelines for Creating Issues](#guidelines-for-creating-issues)
8
10
  - [Security Reporting](#security-reporting)
@@ -29,6 +31,32 @@ The initial committers of the RTC-Tools project are:
29
31
  - Klaudia Horváth
30
32
  - Jesús A. Rodríguez-Sarasty
31
33
 
34
+ ## Current Committers
35
+
36
+ The current committers are:
37
+
38
+ - Jorn Baayen
39
+ - Tjerk Vreeken
40
+ - Bernhard Becker
41
+ - Farid Alavi
42
+ - Joris Gillis
43
+ - Klaudia Horváth
44
+ - Jesús A. Rodríguez-Sarasty
45
+
46
+ Reviews are requested automatically from the owners listed in [CODEOWNERS](CODEOWNERS), which depend on the changed files.
47
+
48
+ ## Emeritus Committers
49
+
50
+ Former committers and contributors who are no longer committers. Emeritus status does not affect membership of the TSC.
51
+
52
+ - Olav van Duin
53
+ - Teresa Piovesan
54
+ - Ailbhe Mitchell
55
+ - Sjoerd Geevers
56
+ - Joris Bentvelsen
57
+ - Jesse van der Wees
58
+ - Matthijs den Toom
59
+
32
60
  ## Ways to Contribute
33
61
 
34
62
  There are many ways you can contribute to RTC-Tools, such as:
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: rtc-tools
3
- Version: 2.9.0a1
3
+ Version: 2.9.0a3
4
4
  Summary: Toolbox for control and optimization of water systems.
5
5
  Project-URL: Homepage, https://oss.deltares.nl/web/rtc-tools/home
6
6
  Project-URL: Download, https://github.com/rtc-tools/rtc-tools/
@@ -197,7 +197,7 @@ Requires-Dist: casadi!=3.6.6,<3.9,>=3.6.3
197
197
  Requires-Dist: defusedxml>=0.7.0
198
198
  Requires-Dist: numpy>=1.23.2
199
199
  Requires-Dist: pymoca==0.9.*,>=0.9.3
200
- Requires-Dist: rtc-tools-channel-flow>=1.4.0
200
+ Requires-Dist: rtc-tools-channel-flow>=1.5.0
201
201
  Requires-Dist: rtc-tools-standard-library>=0.1.2
202
202
  Requires-Dist: scipy>=1.9.2
203
203
  Provides-Extra: all
@@ -44,8 +44,7 @@ removed):
44
44
  Modellers should take care to set proper values for the initial
45
45
  derivatives, in order to avoid spurious waves at the start of the
46
46
  optimization run. In this example we assume a steady state initial
47
- condition for all states except those acted upon by the PID
48
- controllers.
47
+ condition for all states.
49
48
 
50
49
  The Optimization Problem
51
50
  ------------------------
@@ -0,0 +1,90 @@
1
+ Debugging an Optimization Problem
2
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
+
4
+ Overview
5
+ --------
6
+
7
+ This example will illustrate a few tools that can help debugging an optimization problem.
8
+ For example, it will demonstrate how to test an optimization problem by only solving
9
+ for a fixed number of time steps.
10
+
11
+ A Basic Optimization Problem
12
+ ----------------------------
13
+
14
+ For this example, the model is kept very basic.
15
+ We consider a single reservoir with a few target and optimization goals.
16
+ The optimization problem is given below.
17
+
18
+ .. literalinclude:: ../../../examples/single_reservoir/src/single_reservoir.py
19
+ :language: python
20
+ :pyobject: SingleReservoir
21
+
22
+ Optimizing for a given number of time steps
23
+ -------------------------------------------
24
+
25
+ By overwriting the method ``times``, we can control the times for which the problem is optimized.
26
+ In this case, we optimize for all times
27
+ unless the class attribute ``only_check_initial_values`` is set to ``True``.
28
+ Optimizing for only the initial time can be useful
29
+ to check for infeasibilities due to incompatible initial conditions.
30
+
31
+ Exporting the problem as an LP file
32
+ -----------------------------------
33
+
34
+ A linear or mixed-integer linear problem can be written to an LP file, to inspect it or to
35
+ solve it with another solver (e.g. HiGHS or CPLEX)::
36
+
37
+ def export_options(self):
38
+ options = super().export_options()
39
+ options["export_lp"] = True
40
+ return options
41
+
42
+ The file is written to the output folder, e.g. ``SingleReservoir_20250101_120000.lp``. When goal
43
+ programming solves more than one priority, each priority gets its own file with a
44
+ ``_priority_N`` suffix. Export requires an affine objective, affine constraints, and bounds and
45
+ constant terms an LP file can hold (no NaN, no lower bound of +inf, no upper bound of -inf, no
46
+ infinite constant). It raises a :exc:`ValueError` otherwise.
47
+
48
+ By default the constraint rows are unnamed. Set the class attribute
49
+ ``label_all_constraint_rows = True`` to label each row by its origin:
50
+
51
+ * ``initial_residual_{i}`` and ``initial_derivative_{i}``: model equations at the initial time
52
+ * ``collocation_eq{i}__t{t}``: model equation ``i`` at time index ``t``
53
+ * ``delay_{variable}__t{t}``: delayed feedback
54
+ * ``constraint_{i}`` and ``path_constraint_{i}__t{t}``: entries of
55
+ :meth:`~rtctools.optimization.optimization_problem.OptimizationProblem.constraints` and
56
+ :meth:`~rtctools.optimization.optimization_problem.OptimizationProblem.path_constraints`
57
+ * ``objective_priority_{p}``: objective of an earlier priority, added by
58
+ :class:`~rtctools.optimization.single_pass_goal_programming_mixin.SinglePassGoalProgrammingMixin`
59
+
60
+ Elements of a vector constraint get ``__{k}``, and ensemble members ``__m{i}``. A row with a
61
+ finite lower and upper bound becomes two lines, labelled ``__lb`` and ``__ub``. Characters
62
+ that LP readers reject become ``_``, and repeated labels get ``__d{n}``. The labels are also
63
+ available without exporting, in ``transcribed_problem["g_names"]`` after :meth:`optimize`.
64
+
65
+ To name a constraint yourself, set ``named_constraints = True`` and add the name as 4th
66
+ element of the tuple. With this flag on, constraint lists may mix 3- and 4-tuples, so code
67
+ that reads them, like a mixin calling ``super().constraints()``, must accept both::
68
+
69
+ named_constraints = True
70
+
71
+ def path_constraints(self, ensemble_member):
72
+ return [(self.state("Q_release"), 0.0, 10.0, "release_capacity")]
73
+
74
+ This yields rows labelled ``release_capacity__t0__lb``, ``release_capacity__t0__ub``, and so on.
75
+ The other rows stay unnamed, unless ``label_all_constraint_rows`` is set as well.
76
+
77
+ Goal programming can name the constraints it adds: with ``named_constraints = True``, set the
78
+ goal programming option ``constraint_names`` to label them ``{GoalClass}_p{priority}``,
79
+ ``{GoalClass}_p{priority}_abs_pos`` / ``_abs_neg`` for a
80
+ :class:`~rtctools.optimization.min_abs_goal_programming_mixin.MinAbsGoal`, and
81
+ ``pareto_p{priority}`` for the objective constraint kept with ``keep_soft_constraints``.
82
+
83
+ LP readers give a variable without an explicit lower bound the lower bound 0. A variable with
84
+ only an upper bound is therefore written as ``-Inf <= x <= ub``, so that a negative upper bound
85
+ does not make the problem infeasible. Keep the ``-Inf`` if you edit the file by hand.
86
+
87
+ Rows with two infinite bounds are left out of the file. A row that reduces to a constant
88
+ outside its bounds (by more than 1e-9, or with a lower bound above its upper bound) is kept,
89
+ written against a variable ``__zero`` fixed to 0, so that an LP solver also finds the exported
90
+ problem infeasible.
@@ -170,7 +170,7 @@ optimizer.
170
170
  For the goals that want to apply our goals to every timestep, so we use the
171
171
  ``path_goals()`` method. This is a method that returns a list of the path goals
172
172
  we defined above. Note that with path goals, each timestep is implemented as an
173
- independant goal- if we cannot satisfy our min/max on time step A, it will not
173
+ independent goal- if we cannot satisfy our min/max on time step A, it will not
174
174
  affect our desire to satisfy the goal at time step B. Goals that inherit
175
175
  ``StateGoal`` are always path goals and must always be initialized with the
176
176
  parameter ``self``.
@@ -206,8 +206,8 @@ priority is completed.
206
206
  :lineno-match:
207
207
 
208
208
  We want some way to output our intermediate results. This is accomplished using
209
- the ``post()`` method. Again, we nedd to call the ``super()`` method to avoid
210
- overwiting the internal method.
209
+ the ``post()`` method. Again, we need to call the ``super()`` method to avoid
210
+ overwriting the internal method.
211
211
 
212
212
  .. literalinclude:: ../../../examples/goal_programming/src/example.py
213
213
  :language: python
@@ -251,18 +251,18 @@ should print out the following lines::
251
251
 
252
252
  After finishing goals of priority 1:
253
253
  Level goal satisfied at 19 of 21 time steps
254
- Integral of Q_pump = 74.18
255
- Sum of Changes in Q_pump: 7.83
254
+ Integral of Q_pump = 74.10
255
+ Sum of squares of changes in Q_pump: 10.14
256
256
 
257
257
  After finishing goals of priority 2:
258
258
  Level goal satisfied at 19 of 21 time steps
259
259
  Integral of Q_pump = 60.10
260
- Sum of Changes in Q_pump: 11.70
260
+ Sum of squares of changes in Q_pump: 34.89
261
261
 
262
262
  After finishing goals of priority 3:
263
263
  Level goal satisfied at 19 of 21 time steps
264
264
  Integral of Q_pump = 60.10
265
- Sum of Changes in Q_pump: 10.07
265
+ Sum of squares of changes in Q_pump: 21.24
266
266
 
267
267
  As the output indicates, while optimizing for the priority 1 goal, no attempt
268
268
  was made to minimize the integral of ``Q_pump``. The only objective was to
@@ -27,7 +27,7 @@ The problem is given below.
27
27
  :pyobject: ExampleOpt
28
28
 
29
29
  The desired outflow is set to be 1.0 cubic meter / second.
30
- The fixed inflow is ususally 0.0 except at a few moments.
30
+ The fixed inflow is usually 0.0 except at a few moments.
31
31
  To get the desired output, the ideal controllable inflow
32
32
  is the outflow minus the fixed inflow shifted 24 hours in advance.
33
33
  The results are illustrated in the plot below.
@@ -0,0 +1,239 @@
1
+ Initialization of spatially distributed blocks
2
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
+
4
+ The **Linearized Saint-Venant** block is an alternative to the non-linear homotopic block. Both represent spatially distributed hydraulic systems. For distributed hydraulic models, and especially for looped networks, proper initialization is essential. An inappropriate initial state can leave the model with too many degrees of freedom, causing it to converge to solutions that do not represent the actual hydraulic conditions. As a result, operational advice may become unreliable and can significantly under- or overestimate the required control actions.
5
+
6
+ This page discusses the initialization of distributed Saint-Venant blocks and provides guidance on obtaining a physically consistent initial state for optimization.
7
+
8
+ Spatial discretization of RTC-Tools homotopic and LinearisedSV
9
+ --------------------------------------------------------------
10
+
11
+ Both blocks use a staggered grid, with ``Q`` and ``H`` calculated at different points. The user specifies the number of ``H`` nodes as ``n_level_nodes``, and the number of ``Q`` nodes is one greater. The two-node discretization shown in :ref:`discretization_2nodes` is the minimum for the homotopic block; ``LinearisedSV`` requires at least four level nodes. In this case, the variables are:
12
+
13
+ * number of H nodes: n_level_nodes = 2
14
+ * number of Q nodes: n_level_nodes + 1 = 3
15
+ * dx = length / (n_level_nodes – 1), so it is L if n_level_nodes = 2
16
+ * _dxq = dx/2, .., dx.. , dx/2, in this case _dxq= L/2, L/2
17
+
18
+ .. _discretization_2nodes:
19
+
20
+ .. figure:: ../../images/discretization_2nodes.png
21
+ :alt: discretization_2nodes
22
+
23
+ Figure 1: Spatial discretization in RTC-Tools using 2 nodes
24
+
25
+ .. _discretization_3nodes:
26
+
27
+ .. figure:: ../../images/discretization_3nodes.png
28
+ :alt: discretization_3nodes
29
+
30
+ Figure 2: Spatial discreatization in RTC-Tools using 3 nodes
31
+
32
+ Similarly, written for 3 nodes is shown in :ref:`discretization_3nodes`. Both homotopic linear and linearized SV has the same way. LinearisedSV needs minimum 4 level nodes due to the code formulation. That might be generalized later.
33
+
34
+ .. note::
35
+
36
+ When working with distributed elements, it is always a good practice to visualize all the H and Q when building a model to be able to judge if the model is realistic.
37
+
38
+
39
+ Initial Conditions and Degrees of Freedom
40
+ -----------------------------------------
41
+
42
+ In a traditional simulation model, a channel requires an initial state and two boundary conditions. The initial state consists of the discharge (``Q``) and water level (``H``) values at all discretization points at the start of the simulation. Typical boundary conditions are, for example, an upstream discharge and a downstream water level.
43
+
44
+ In an optimization model, the same Saint-Venant equations are solved. However, any variable that is not fixed by measurements, boundary conditions, constraints, or objectives becomes a degree of freedom. The optimizer will assign values to such variables if this helps improve the objective function, regardless of whether these values represent the actual hydraulic state of the system.
45
+
46
+ As a result, it is crucial to limit the degrees of freedom during initialization. If the initial state is insufficiently constrained, the optimization may exploit unrealistic initial water levels or discharges to obtain a better objective value. The resulting operational advice may then be inconsistent with the current hydraulic situation and therefore be unreliable.
47
+
48
+ The remainder of this page discusses how to obtain a physically consistent initial state while avoiding unnecessary constraints. First, a brief overview of the theory behind the distributed Saint-Venant equations is given.
49
+
50
+ Example using three level nodes, fixing the initial values
51
+ ----------------------------------------------------------
52
+
53
+ Suppose we have three water-level nodes as shown in :ref:`staggered_grid_3` and the corresponding simplified equations in :eq:`continuity-upstream`-:eq:`momentum-downstream`. Although these equations represent a simplified version of the linear model, the variable locations and relationships are identical to those in the non-linear model.
54
+
55
+ The set of five equations contains twelve variables: five at time level :math:`n`,
56
+ :math:`h_1^n`, :math:`h_2^n`, :math:`h_3^n`, :math:`q_2^n`, and :math:`q_3^n`,
57
+ and seven at time level :math:`n+1`,
58
+ :math:`h_1^{n+1}`, :math:`h_2^{n+1}`, :math:`h_3^{n+1}`,
59
+ :math:`q_1^{n+1}`, :math:`q_2^{n+1}`, :math:`q_3^{n+1}`, and
60
+ :math:`q_4^{n+1}`. This gives twelve unknowns and five equations,
61
+ resulting in seven degrees of freedom.
62
+
63
+ For the first time level, one boundary condition can be specified while the other may be left free for the optimizer. For example, a common approach is to fix the upstream boundary (for example, by imposing a closed boundary with ``Q = 0``) while leaving the downstream boundary, such as a pump or sluice, free to be optimized. This leaves five initial values that must be provided. In this example, these could be all ``Q`` and ``H`` values at time level zero, although alternative formulations are possible, such as specifying derivatives instead of some of the state variables.
64
+
65
+ For subsequent time steps, the five variables from the previous time step are known. Consequently, seven unknowns remain and are governed by five equations, leaving two additional conditions to be specified. In a simulation model, these would typically be provided as two boundary conditions.
66
+
67
+ .. _staggered_grid_3:
68
+
69
+ .. figure:: ../../images/staggered_grid_3.png
70
+ :alt: staggered_grid_3
71
+
72
+ Figure 3: Staggered grid using three level nodes
73
+
74
+ For a channel discretized with three water-level nodes and four discharge nodes
75
+ (two internal nodes and two boundary nodes), the continuity equations are formulated
76
+ at the water-level nodes, while the momentum equations are formulated at the two
77
+ internal discharge nodes using a staggered grid.
78
+
79
+ The continuity equations enforce conservation of mass and relate the temporal
80
+ change in water level to the spatial gradient of the discharge:
81
+
82
+ .. _eq-continuity-upstream:
83
+
84
+ .. math::
85
+ :label: continuity-upstream
86
+
87
+ \frac{h_{1}^{n+1} - h_{1}^{n}}{\Delta t}
88
+ + c \frac{q_{2}^{n+1} - q_{1}^{n+1}}{\Delta x / 2} = 0,
89
+
90
+ .. _eq-continuity-middle:
91
+  
92
+ .. math::
93
+ :label: continuity-middle
94
+
95
+ \frac{h_{2}^{n+1} - h_{2}^{n}}{\Delta t}
96
+ + c \frac{q_{3}^{n+1} - q_{2}^{n+1}}{\Delta x} = 0,
97
+
98
+ .. _eq-continuity-downstream:
99
+
100
+ .. math::
101
+ :label: continuity-downstream
102
+
103
+ \frac{h_{3}^{n+1} - h_{3}^{n}}{\Delta t}
104
+ + c \frac{q_{4}^{n+1} - q_{3}^{n+1}}{\Delta x / 2} = 0.
105
+
106
+ At the discharge nodes, the momentum equations describe the temporal evolution
107
+ of the discharge as a balance between inertia, water level gradients, friction,
108
+ and external forcing:
109
+
110
+ .. _eq-momentum-upstream:
111
+
112
+ .. math::
113
+ :label: momentum-upstream
114
+
115
+ \frac{q_{2}^{n+1} - q_{2}^{n}}{\Delta t}
116
+ + a \frac{q_{3}^{n+1} - q_{1}^{n+1}}{1.5\Delta x}
117
+ + b \frac{h_{2}^{n+1} - h_{1}^{n+1}}{\Delta x}
118
+ + d q_{2}^{n+1}
119
+ + e = 0,
120
+
121
+ .. _eq-momentum-downstream:
122
+
123
+ .. math::
124
+ :label: momentum-downstream
125
+
126
+ \frac{q_{3}^{n+1} - q_{3}^{n}}{\Delta t}
127
+ + a \frac{q_{4}^{n+1} - q_{2}^{n+1}}{1.5\Delta x}
128
+ + b \frac{h_{3}^{n+1} - h_{2}^{n+1}}{\Delta x}
129
+ + d q_{3}^{n+1}
130
+ + e = 0.
131
+
132
+ The discretization uses half-cell lengths at the upstream and downstream
133
+ boundaries for the continuity equations. Similarly, the momentum equations at
134
+ the discharge nodes employ effective stencil lengths of :math:`1.5\Delta x`
135
+ to account for their location between the water level nodes and the channel
136
+ boundaries.
137
+
138
+
139
+
140
+ Possible initialization options: steady state
141
+ ---------------------------------------------
142
+
143
+
144
+ Suppose that not all initial conditions are known, or that we prefer not to specify them explicitly. In that case, the model can be initialized from a steady state. Rather than prescribing the initial ``Q`` and ``H`` values, the initial time derivatives can be set to zero, meaning that the model is forced to start from a stationary hydraulic condition.
145
+
146
+ For the three-node example, this adds five additional equations, one for each state derivative that is fixed to zero. The two remaining degrees of freedom can then be used to define boundary conditions. For example, a single discharge value can be prescribed. Because the system is in steady state, this discharge applies throughout the channel. In addition, one water level can be specified at any location in the system, with all remaining water levels following from the equations.
147
+
148
+ Alternatively, for the two-node case, setting all initial derivatives to zero allows one discharge and one water level to be defined. Thus, as in the three-node case, this property is independent of the number of discretization points.
149
+
150
+
151
+
152
+ Comparing Initialization Approaches
153
+ -----------------------------------
154
+
155
+ We have discussed two approaches for initializing a distributed Saint-Venant model: providing all initial ``Q`` and ``H`` values, or assuming an initial steady state. Both approaches have advantages and disadvantages, and in practice a mixed approach is often preferred.
156
+
157
+ Let us first consider the case where all initial ``Q`` and ``H`` values are prescribed. In reality, these values are rarely known exactly. Even when measurements are available, forcing the model to match them exactly may be problematic. The optimizer must find a solution to the Saint-Venant equations that satisfies these prescribed values, but the model is only an approximation of reality. Errors in cross-section geometry, neglected two-dimensional effects, uncertainty in roughness coefficients, and spatial discretization errors can all contribute to inconsistencies between the model and the measurements.
158
+
159
+ As a result, the model may compensate by generating large initial derivatives. Physically, this corresponds to the generation of artificial waves that propagate through the system. The risk of such spurious waves is particularly high when the first optimization timestep is also used as the first operational timestep, which is often the case. Note that with this approach all initial state variables must be specified. For channels with multiple internal nodes, both water levels and discharges must be prescribed at every node.
160
+
161
+ Steady-state initialization is generally more robust because it guarantees that no artificial waves are introduced at the start of the simulation. The resulting hydraulic state is internally consistent with the Saint-Venant equations and therefore provides a stable starting point for the optimization.
162
+
163
+ However, a steady-state assumption is not always appropriate. If the system is known to be far from equilibrium, for example during rapidly changing flows, pump transitions, gate operations, or flood events, a steady-state initialization may fail to represent the actual hydraulic situation. In such cases, valuable information from field measurements, particularly water-level observations, would be ignored. The resulting initial state may be numerically consistent but physically unrealistic.
164
+
165
+ For this reason, a mixed approach is often preferable. Rather than fixing all state variables or enforcing a perfect steady state, the initialization can combine measured water levels with constraints on the initial derivatives. This allows the model to remain close to the observed system state while preventing the introduction of unrealistic waves. The optimization is then given sufficient flexibility to reconcile measurements with the hydraulic equations without exploiting unrealistic initial conditions.
166
+
167
+
168
+ Mixed approach
169
+ --------------
170
+
171
+ A third, mixed approach is also possible. Instead of enforcing a full steady state by setting all initial derivatives to zero, only the discharge derivatives can be constrained to be small (or equal to zero). This still allows different discharge values along the channel, which is often more realistic than assuming a perfectly uniform flow distribution.
172
+
173
+ For the three-node example, starting with seven degrees of freedom, setting the two internal discharge derivatives to zero leaves five degrees of freedom. Specifying two independent boundary conditions leaves three, so three further independent scalar conditions are needed to determine a unique initial state. Specifying only one additional discharge is insufficient.
174
+
175
+ In practice, the goal is often not to define a unique state exactly, but rather to guide RTC-Tools towards a physically realistic state while avoiding excessive freedom for the optimizer. Finding the right balance can be challenging.
176
+
177
+ One practical approach is to impose bounds around measured water levels and to constrain the initial discharges to a plausible range. In this way, the initialization remains close to the observed system state without forcing the model to exactly match measurements that may be inconsistent with the Saint-Venant equations.
178
+
179
+ Some important observations are:
180
+
181
+ * Water levels are generally more sensitive than discharges. The same water level profile may correspond to very different discharge distributions. Therefore, it is usually not good practice to enforce measured water levels exactly.
182
+ * Always validate the initialization results by inspecting all ``Q`` and ``H`` values and checking whether the model produces a reasonable hydraulic state when no operational changes are applied.
183
+ * Before investing effort in initialization, consider whether a spatially discretized model is actually required. In some cases, a simpler model may provide sufficient accuracy with fewer initialization challenges.
184
+
185
+ In many practical applications, the most robust strategy is to search for a state that is both close to steady state and close to the available measurements. This can be achieved by constraining derivatives to remain within a specified range around zero, while applying similar bounds around measured values. Measured quantities can also be represented as high-priority goals rather than hard constraints, allowing the optimizer to reconcile measurements with the hydraulic equations when perfect agreement is impossible.
186
+
187
+ Because some degrees of freedom remain available, additional system knowledge can be incorporated. For example, an upstream discharge measurement may be prescribed, a range can be specified for the downstream discharge, and bounds can be applied to selected water-level measurements. This often leads to a physically realistic and numerically robust initialization.
188
+
189
+ Regardless of the chosen approach, initialization should always be tested thoroughly. Small changes in the initialization strategy can have a significant impact on the resulting flow distribution, water-level profile, and ultimately on the operational advice produced by the optimization.
190
+
191
+
192
+ .. note::
193
+
194
+ For looped networks there is even less degree of freedom, you should think similarly. Storage elements also influence this, therefore we suggest to always set zero (or small) initial flow to these elements.
195
+
196
+
197
+
198
+
199
+ Example
200
+ -------
201
+
202
+ Consider a channel for which the downstream water level is prescribed as a boundary condition and the downstream discharge has a target value of 100 m³/s. For this discharge, the corresponding steady-state upstream water level is known to be 0.00776 m.
203
+
204
+ The examples below compare three situations: an initialization at the correct steady state, an initialization using a measured water level of 0.05 m, and an initialization without a steady-state assumption. The optimisation goal in all cases is to achieve the steady-state water level.
205
+
206
+ The downstream water level is prescribed as a boundary condition and is therefore fixed from the very first timestep onward. All other state variables are left free. An objective is defined on the upstream water level, which is required to reach 0.00776 m.
207
+
208
+ The model must determine the corresponding upstream discharge. For a channel with three water-level nodes, there are three water levels and four discharges. Because the downstream water level is fixed by the boundary condition, two water levels and four discharges remain free.
209
+
210
+ .. _Figure_st100q:
211
+
212
+ .. figure:: ../../images/initialization/Figure_st100q.png
213
+ :alt: Figure_st100q
214
+
215
+ Figure 4: Steady-state initialization with a discharge of 100 m³/s.
216
+
217
+ .. _steady5h:
218
+
219
+ .. figure:: ../../images/initialization/steady5h.png
220
+ :alt: steady5h
221
+
222
+ Figure 5: Steady-state initialization with a measured water level.
223
+
224
+ .. _Figure_give:
225
+
226
+ .. figure:: ../../images/initialization/Figure_give.png
227
+ :alt: Figure_give
228
+
229
+ Figure 6: Initialization without a steady-state assumption.
230
+
231
+ The first case, shown in :ref:`Figure_st100q`, demonstrates the ideal situation. The steady-state discharge corresponds exactly to the target water level, resulting in a smooth initialization and a smooth transition into the optimization horizon. No significant control actions are required at the first timestep.
232
+
233
+ However, if the target water level differs from the steady-state (0.05 m) water level used for initialization, the behaviour changes considerably. In the example shown in :ref:`steady5h`, the optimizer immediately attempts to move the system towards the target state. As a result, a very aggressive control action is taken at the first timestep.
234
+
235
+ Finally, if no steady-state condition is imposed during initialization, as shown in :ref:`Figure_give`, the model must determine all unconstrained state variables itself. Although this may lead to a feasible solution, it can also result in large discontinuities in both water levels and discharges at the start of the simulation. In this example, a significant drop in water level and discharge occurs during the first timestep, indicating that the initial hydraulic state is inconsistent with the optimisation objectives and boundary conditions.
236
+
237
+ These examples illustrate that both the quality of the initialization and its consistency with the optimisation goals are important. A steady-state initialization can prevent spurious waves, but only if the chosen steady state is representative of the desired operating condition.
238
+
239
+
@@ -19,7 +19,7 @@ The Model
19
19
  .. note::
20
20
 
21
21
  This example uses the same hydraulic model as the basic example. For a
22
- detalied explaination of the hydraulic model, see :doc:`basic`.
22
+ detailed explanation of the hydraulic model, see :doc:`basic`.
23
23
 
24
24
 
25
25
  In OpenModelica Connection Editor, the model looks like this:
@@ -153,7 +153,7 @@ However, it is usually helpful to track how the solution changes after
153
153
  optimizing each priority level. To track these changes, we need to add three
154
154
  methods.
155
155
 
156
- We define the ``priority_completed()`` method to inspect and summerize the
156
+ We define the ``priority_completed()`` method to inspect and summarize the
157
157
  results. These are appended to our intermediate results variable after each
158
158
  priority is completed.
159
159
 
@@ -162,8 +162,8 @@ priority is completed.
162
162
  :pyobject: Example.priority_completed
163
163
  :lineno-match:
164
164
 
165
- We output our intermediate results using the ``post()`` method. Again, we nedd
166
- to call the ``super()`` method to avoid overwiting the internal method.
165
+ We output our intermediate results using the ``post()`` method. Again, we need
166
+ to call the ``super()`` method to avoid overwriting the internal method.
167
167
 
168
168
  .. literalinclude:: ../../../examples/lookup_table/src/example.py
169
169
  :language: python
@@ -219,7 +219,7 @@ minimize the number of states in violation of the water level goal.
219
219
 
220
220
  After optimizing for the priority 2 goal, the solver was able to find a solution
221
221
  that reduced the integral of ``Q_release`` without increasing the number of
222
- timesteps where the water level exceded the limit.
222
+ timesteps where the water level exceeded the limit.
223
223
 
224
224
  Extracting Results
225
225
  ------------------
@@ -182,7 +182,7 @@ All together, the whole example script is as follows:
182
182
  Running the Optimization Problem
183
183
  --------------------------------
184
184
 
185
- .. note:: An explaination of bonmin behaviour and output goes here.
185
+ .. note:: An explanation of bonmin behaviour and output goes here.
186
186
 
187
187
 
188
188
 
@@ -78,7 +78,7 @@ The python script consists of the following blocks:
78
78
  * Definition of the optimization problem class
79
79
 
80
80
  * Pre-processing
81
- * Setting of varaible nominals
81
+ * Setting of variable nominals
82
82
  * Definition of constraints
83
83
  * Additional configuration of the solver
84
84
  * Post-processing
@@ -156,7 +156,7 @@ joining the upper and lower reservoirs cannot be used at the same time.
156
156
 
157
157
  Variable nominals can be set in the OpenModelica model file, or via the variable_nominal definition.
158
158
  This can be useful when a variable nominal depends on a non-fixed value. Here the
159
- power_nominal caluclated in the ``pre`` is set to be the nominal for the states ``TotalGeneratingPower``
159
+ power_nominal calculated in the ``pre`` is set to be the nominal for the states ``TotalGeneratingPower``
160
160
  and ``TurbinePower``.
161
161
 
162
162
  .. literalinclude:: ../../../examples/pumped_hydropower_system/src/example.py
@@ -13,6 +13,7 @@ This section provides examples demonstrating key features of RTC-Tools optimizat
13
13
  optimization/channel_pulse
14
14
  optimization/step_response
15
15
  optimization/channel_wave_damping
16
+ optimization/linearised_SV
16
17
  optimization/debugging
17
18
  optimization/fallback_options
18
19
  optimization/integrator_delay
@@ -9,15 +9,15 @@ forecast_names = ["forecast1", "forecast2"]
9
9
  dir_template = "../../../examples/ensemble/reference_output/{}/timeseries_export.csv"
10
10
 
11
11
  # Import Data
12
- forcasts = {}
12
+ forecasts = {}
13
13
  for forecast in forecast_names:
14
14
  data_path = dir_template.format(forecast)
15
- forcasts[forecast] = np.genfromtxt(
15
+ forecasts[forecast] = np.genfromtxt(
16
16
  data_path, delimiter=",", encoding=None, dtype=None, names=True, case_sensitive="lower"
17
17
  )
18
18
 
19
19
  # Get times as datetime objects
20
- times = [datetime.strptime(x, "%Y-%m-%d %H:%M:%S") for x in forcasts[forecast_names[0]]["time"]]
20
+ times = [datetime.strptime(x, "%Y-%m-%d %H:%M:%S") for x in forecasts[forecast_names[0]]["time"]]
21
21
 
22
22
  n_subplots = 3
23
23
  fig, axarr = plt.subplots(n_subplots, sharex=True, figsize=(8, 4 * n_subplots))
@@ -36,7 +36,7 @@ axarr[2].set_ylabel("Flow Rate [m³/s]")
36
36
  # Plot Ensemble Members
37
37
  for idx, forecast in enumerate(forecast_names):
38
38
  # Upper Subplot
39
- results = forcasts[forecast]
39
+ results = forecasts[forecast]
40
40
  if idx == 0:
41
41
  axarr[0].plot(times, results["v_max"], label="Max", linewidth=2, color="r", linestyle="--")
42
42
  axarr[0].plot(times, results["v_min"], label="Min", linewidth=2, color="g", linestyle="--")