Ribasim

The biggest breaking change of this release is the refactoring of the Ribasim Python API.
You can find its usage in the [examples](https://deltares.github.io/Ribasim/python/examples.html).
The same examples with the old API can be found in this [PDF](https://github.com/Deltares/Ribasim/files/14722978/Ribasim.-.Examples.pdf).

Breaking
* Ribasim Python: Add-API by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1110
* Initialize spatial table as GeoDataFrame by Huite in https://github.com/Deltares/Ribasim/pull/1242
* Enable read method again with the new add API by evetion in https://github.com/Deltares/Ribasim/pull/1243
* Infer edge type in add API by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1275

Changed
* Use 32 bit signed integer for all IDs and priorities by visr in https://github.com/Deltares/Ribasim/pull/1252
* QGIS: don't crash on unknown layers in database by visr in https://github.com/Deltares/Ribasim/pull/1265
* Improve Model repr and make more API private by visr in https://github.com/Deltares/Ribasim/pull/1270
* Sort Node and Edge tables by visr in https://github.com/Deltares/Ribasim/pull/1272
* Refactor function UserDemand in read.jl by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1268
* Add `model.node_table()`, take two by visr in https://github.com/Deltares/Ribasim/pull/1279
* Assert no timezone for naive datetimes. by Huite in https://github.com/Deltares/Ribasim/pull/1286
* Test Ribasim Python with multi environment feature by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1285
* Examples: bring necessary symbols into scope by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1287
* activate subnetwork plotting by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1291
* Plot listen edges by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1288
* Stop pinning Python version for default environment by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1290
* change int to string for PID listen_node_type by Jingru923 in https://github.com/Deltares/Ribasim/pull/1293
* Don't save states on callbacks by visr in https://github.com/Deltares/Ribasim/pull/1281
* Fix variable name in Python tests by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1294
* Add FlowDemand node type by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1188
* Treat `UserDemand` return flow as a source by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1226
* Update version numbers by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1303
* Add support for indexing into TableModel, except Edge by Huite in https://github.com/Deltares/Ribasim/pull/1304


**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.4.0...v2024.5.1

What's Changed
* Update pixi lock file by github-actions in https://github.com/Deltares/Ribasim/pull/1205
* Fix precompile script by visr in https://github.com/Deltares/Ribasim/pull/1211
* Deleted relevant code of alternative object functions in Ribasim python and core by Jingru923 in https://github.com/Deltares/Ribasim/pull/1199
* Document `listen_feature_type` in `DiscreteControl / condition` by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1214
* Stop 'Julia auto update' from upgrading Julia version by visr in https://github.com/Deltares/Ribasim/pull/1215
* Update to HiGHS 1.7.0 by visr in https://github.com/Deltares/Ribasim/pull/1219
* QGIS plugin updates for `node_type`, remove `explode_and_connect` by visr in https://github.com/Deltares/Ribasim/pull/1220
* Add plotting support for multiple line segment edges by Huite in https://github.com/Deltares/Ribasim/pull/1223
* Pin pixi version for now in CI by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1225
* Add `pixi run ribasim-models` to run all test models by visr in https://github.com/Deltares/Ribasim/pull/1224


**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.3.0...v2024.4.0

For allocation we added a new LevelDemand node, and we now support a 'Basin / area' table to put polygons. The flow results now represent a mean flow from the timestamp until the next.

There were a number of breaking changes. See the associated pull request for upgrade information. Some were aimed at making the configuration options simpler. To navigate these changes better it helps to know what Ribasim version a model is made for, so we add `ribasim_version` as a required TOML key. The output files are also tagged with the version of the CLI that produced them. Adding extra columns with a `meta_` prefix is still possible, but the prefix is no longer applied automatically to prevent accidental usage when a column name is not correct.

Breaking
- Introduce consistent naming of subnetworks and allocation networks by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1130
- Make `results.compression` a Boolean by visr in https://github.com/Deltares/Ribasim/pull/1147
- Support only fixed `saveat` intervals, set default at daily by visr in https://github.com/Deltares/Ribasim/pull/1155
- Add `node_id` column to Node table by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1149
- Remove `adaptive` solver config option by visr in https://github.com/Deltares/Ribasim/pull/1170
- Rename `User` to `UserDemand` by visr in https://github.com/Deltares/Ribasim/pull/1175
- Write `ribasim_version` to TOML and warn in core if it is different by visr in https://github.com/Deltares/Ribasim/pull/1181
- Don't auto add `meta_` prefix, error. by visr in https://github.com/Deltares/Ribasim/pull/1186
- Disable the alternative object functions by Jingru923 in https://github.com/Deltares/Ribasim/pull/1193

Changed
- Use equality constraint in allocation flow conservation by Jingru923 in https://github.com/Deltares/Ribasim/pull/1083
- Reduce binary size by leaving out artifacts by visr in https://github.com/Deltares/Ribasim/pull/1176
- Mean output flows by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1159

Added
- Water supply/demand by basins in allocation (new node type `LevelDemand`) by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1082
- Add `ribasim_version` metadata to Arrow results by visr in https://github.com/Deltares/Ribasim/pull/1145
- Basin allocation output by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1148
- Relax PID validation by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1194
- Add realized user demand for BMI by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1190
- Add optional 'Basin / area' spatial table by visr in https://github.com/Deltares/Ribasim/pull/1200

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.2.0...v2024.3.0

<details>
<summary>
All changes
</summary>

What's Changed
* Set mypypath dynamically by deltamarnix in https://github.com/Deltares/Ribasim/pull/1116
* change leq to eq constrain in flow conservation by Jingru923 in https://github.com/Deltares/Ribasim/pull/1083
* Avoid lookup of node type from Node metadata by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1120
* Don't add `Basin / static` if there are no flows by visr in https://github.com/Deltares/Ribasim/pull/1135
* Introduce consistent naming of subnetworks and allocation networks by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1130
* Update Julia manifest by github-actions in https://github.com/Deltares/Ribasim/pull/1138
* Water supply/demand by basins in allocation (new node type `LevelDemand`) by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1082
* Allow no allocation model by visr in https://github.com/Deltares/Ribasim/pull/1134
* Update pixi lock file by github-actions in https://github.com/Deltares/Ribasim/pull/1139
* Install QGIS plugins on `pixi run install` by visr in https://github.com/Deltares/Ribasim/pull/1140
* Rename AllocationTarget to TargetLevel by visr in https://github.com/Deltares/Ribasim/pull/1141
* Add quarto on all platforms by visr in https://github.com/Deltares/Ribasim/pull/1142
* Update Edge Schema docs by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1146
* Add `ribasim_version` metadata to Arrow results by visr in https://github.com/Deltares/Ribasim/pull/1145
* Make results.compression a Boolean by visr in https://github.com/Deltares/Ribasim/pull/1147
* Run a model without compression by visr in https://github.com/Deltares/Ribasim/pull/1150
* Basin allocation output by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1148
* Support only fixed saving intervals, set default at daily by visr in https://github.com/Deltares/Ribasim/pull/1155
* Lock Julia patch version by visr in https://github.com/Deltares/Ribasim/pull/1167
* Add `node_id` column to `Node` table by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1149
* Fix docs: use node_type instead of type by visr in https://github.com/Deltares/Ribasim/pull/1171
* CompatHelper: bump compat for DiffEqCallbacks to 3 for package core, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/1173
* Remove `adaptive` solver config option by visr in https://github.com/Deltares/Ribasim/pull/1170
* Rename TargetLevel again: LevelDemand by visr in https://github.com/Deltares/Ribasim/pull/1172
* Rename User to UserDemand by visr in https://github.com/Deltares/Ribasim/pull/1175
* Reduce binary size by leaving out artifacts by visr in https://github.com/Deltares/Ribasim/pull/1176
* Update codegen pixi task by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1180
* Remove dependency `types-requests` by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1179
* Write `ribasim_version` to TOML and warn in core if it is different by visr in https://github.com/Deltares/Ribasim/pull/1181
* test is_flow_constraining by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1182
* Change the default objective_type to linear_absolute by visr in https://github.com/Deltares/Ribasim/pull/1184
* docs: Fix node tables by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1185
* Don't auto add `meta_` prefix, error. by visr in https://github.com/Deltares/Ribasim/pull/1186
* Fix broken hyperlinks by visr in https://github.com/Deltares/Ribasim/pull/1187
* Mean output flows by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1159
* Disable the alternative object functions by Jingru923 in https://github.com/Deltares/Ribasim/pull/1193
* Relax PID validation by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1194
* add realized user demand and expose via BMI by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1190
* Use only explicit imports by visr in https://github.com/Deltares/Ribasim/pull/1198
* Clarify documentation on truth state ordering by visr in https://github.com/Deltares/Ribasim/pull/1197
* Fix ruff warnings by visr in https://github.com/Deltares/Ribasim/pull/1201
* Add optional 'Basin / area' spatial table by visr in https://github.com/Deltares/Ribasim/pull/1200

</details>

Added
- Allow missing 'Basin / time' data by Huite in 1028
- Also allow Missing in basin.static by Huite in 1079
- Support main allocation network by SouthEndMusic in 1006
- Save allocation flows by SouthEndMusic in 1012
- Add max_flow_rate to LinearResistance by visr in 1100

Changed
- Move version from YYYY.0M.MICRO to YYYY.MINOR.MICRO by Hofer-Julian in 1089


**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.01.1...v2024.2.0

<details>
<summary>
All changes
</summary>

What's Changed
* Simplify release process docs by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1001
* Update allocation docs with main network by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1011
* CompatHelper: bump compat for Dictionaries to 0.4 for package core, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/1013
* Fold docs/Project.toml into root/Project.toml by visr in https://github.com/Deltares/Ribasim/pull/1014
* Remove using S for storage (use u) by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1003
* Update pre-commit hooks by github-actions in https://github.com/Deltares/Ribasim/pull/1024
* Keep only the root and core project by visr in https://github.com/Deltares/Ribasim/pull/1021
* Validate allocation input by Jingru923 in https://github.com/Deltares/Ribasim/pull/972
* Stop running CompatHelper on root project again by visr in https://github.com/Deltares/Ribasim/pull/1063
* Move release script to Python and run it with pixi by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1029
* Allow missing 'Basin / time' data by Huite in https://github.com/Deltares/Ribasim/pull/1028
* Merge main allocation network feature branch by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1006
* Remove confusing sentence for PidControl by visr in https://github.com/Deltares/Ribasim/pull/1009
* Improve docs home page by gijsber in https://github.com/Deltares/Ribasim/pull/1002
* Update pixi lock file and fix mypy issues by visr in https://github.com/Deltares/Ribasim/pull/1065
* Bump prefix-dev/setup-pixi from 0.4.3 to 0.5.1 by dependabot in https://github.com/Deltares/Ribasim/pull/1068
* Bump peter-evans/create-pull-request from 5 to 6 by dependabot in https://github.com/Deltares/Ribasim/pull/1069
* Fix doc anchor in docs by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1072
* Save allocation flows by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1012
* Start updating versions/lock-files on different dates by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1075
* Also allow Missing in basin.static by Huite in https://github.com/Deltares/Ribasim/pull/1079
* Testmodels: run one year instead of ten by Huite in https://github.com/Deltares/Ribasim/pull/1080
* Bump codecov/codecov-action from 3 to 4 by dependabot in https://github.com/Deltares/Ribasim/pull/1070
* Switch components over to the same calver version number by visr in https://github.com/Deltares/Ribasim/pull/1086
* Remove docker from QGIS tests by deltamarnix in https://github.com/Deltares/Ribasim/pull/943
* Introduce flat demand vector and expose via BMI by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1081
* Move version from YYYY.0M.MICRO to YYYY.MINOR.MICRO by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1089
* Validate the equality of timestamps in a test by deltamarnix in https://github.com/Deltares/Ribasim/pull/1095
* Remove `update_timestep` in Ribasim Python by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1099
* Reorganize code among files in core by visr in https://github.com/Deltares/Ribasim/pull/1101
* Follow up to 1099 by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1102
* Generate python code for schemas directly from Julia by deltamarnix in https://github.com/Deltares/Ribasim/pull/1096
* Correct precipitation equation by visr in https://github.com/Deltares/Ribasim/pull/1088
* Add roundtrip test for model files by visr in https://github.com/Deltares/Ribasim/pull/1007
* Add max_flow_rate to LinearResistance by visr in https://github.com/Deltares/Ribasim/pull/1100
* Bump pre-commit/action from 3.0.0 to 3.0.1 by dependabot in https://github.com/Deltares/Ribasim/pull/1106
* Bump prefix-dev/setup-pixi from 0.4.1 to 0.5.1 by dependabot in https://github.com/Deltares/Ribasim/pull/1107
* Bump codecov/codecov-action from 3 to 4 by dependabot in https://github.com/Deltares/Ribasim/pull/1108
* Use token argument to all codecov-actions by visr in https://github.com/Deltares/Ribasim/pull/1109
* Add mypy-ribasim-qgis to github actions by deltamarnix in https://github.com/Deltares/Ribasim/pull/1078
* Make node ID unique to the node type by visr in https://github.com/Deltares/Ribasim/pull/1113
* Go back to the old FeatureFormSuppress to support older QGIS by visr in https://github.com/Deltares/Ribasim/pull/1115

</details>

This version allows for coupling to MODFLOW 6 with the [latest imod-coupler release](https://github.com/Deltares/imod_coupler/releases/tag/v2024.01.1).

Furthermore it contains many improvements and bugfixes.
We recommend using Ribasim Python with Pandas 2.1.4.

Breaking change

- Always require 'Basin / state' as an initial condition by visr in https://github.com/Deltares/Ribasim/pull/977
- Use flow_rate rather than discharge in TabulatedRatingCurve by visr in https://github.com/Deltares/Ribasim/pull/992

Added

- Add update_subgrid_level to BMI functions by Huite in https://github.com/Deltares/Ribasim/pull/986
- Support `ribasim --version` to get the version number by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/997

Fixed

- Fix and change table sorting in Python by visr in https://github.com/Deltares/Ribasim/pull/903
- Always write fid index of Node and Edge tables by visr in https://github.com/Deltares/Ribasim/pull/995

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.01.0...v2024.01.1

<details>
<summary>
All changes
</summary>

What's Changed
* No more warning in Ribasim Python when plotting model without edges by Jingru923 in https://github.com/Deltares/Ribasim/pull/940
* Update our depdendencies by visr in https://github.com/Deltares/Ribasim/pull/942
* Adapt download links by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/949
* Launch debug julia by Huite in https://github.com/Deltares/Ribasim/pull/953
* [ci] Fix intermittent QGIS test failures. by evetion in https://github.com/Deltares/Ribasim/pull/939
* Set initial level after parameter creation by Huite in https://github.com/Deltares/Ribasim/pull/955
* Reflect current release process in docs by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/948
* Fix and change table sorting in Python by visr in https://github.com/Deltares/Ribasim/pull/903
* Pixi: use latest QGIS release by visr in https://github.com/Deltares/Ribasim/pull/958
* Docs additions for output, logging, and metadata by Huite in https://github.com/Deltares/Ribasim/pull/961
* Remove coupling docs by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/963
* Add pixi task to update registry by visr in https://github.com/Deltares/Ribasim/pull/962
* Fix looped subnetwork by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/965
* Bump prefix-dev/setup-pixi from 0.4.1 to 0.4.3 by dependabot in https://github.com/Deltares/Ribasim/pull/974
* Pin number of processes used in Python tests to 4 by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/975
* Disable qgis tests by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/976
* Refactor `sort_keys` implementation by evetion in https://github.com/Deltares/Ribasim/pull/970
* Always require 'Basin / state' as an initial condition by visr in https://github.com/Deltares/Ribasim/pull/977
* Add cron job to auto-update pixi lock file by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/978
* Update pixi lock file by github-actions in https://github.com/Deltares/Ribasim/pull/979
* Auto update Julia manifest by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/980
* Julia manifest update the root environment by visr in https://github.com/Deltares/Ribasim/pull/981
* Add update_subgrid_level to BMI functions by Huite in https://github.com/Deltares/Ribasim/pull/986
* Pin pandas to less noisy 2.1.4 by visr in https://github.com/Deltares/Ribasim/pull/988
* Not part of bmi/xmi: add the method to python api by Huite in https://github.com/Deltares/Ribasim/pull/990
* Use flow_rate rather than discharge in TabulatedRatingCurve by visr in https://github.com/Deltares/Ribasim/pull/992
* Add two_basin model to ribasim-testsmodels by Huite in https://github.com/Deltares/Ribasim/pull/994
* Always write fid index of Node and Edge tables by visr in https://github.com/Deltares/Ribasim/pull/995
* Update version numbers by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/996
* Allow compiled binaries to get version by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/997

</details>

Added

- Add flow cost (886)
- Don't require consecutive Node IDs (885)
- Add validation rules in docs (896)
- Allocation fractional flow constraints (854)
- Allocation example (901)
- Remove QGIS checkboxes in dataset widget (919)
- Add Linux builds (930)
- Add log file to results (911)
- Test models doc (936)

Fixed

- Re-enable edge validation (888)

New Contributors
* Jingru923 made their first contribution in https://github.com/Deltares/Ribasim/pull/936

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2023.12.0...v2024.01.0

<details>
<summary>
All changes
</summary>

What's Changed
* Switch to different TimeZones branch by visr in https://github.com/Deltares/Ribasim/pull/880
* CompatHelper: bump compat for TimeZones to 1 for package core, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/882
* CompatHelper: bump compat for TimeZones to 1 for package create_binaries, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/883
* Bump actions/setup-python from 4 to 5 by dependabot in https://github.com/Deltares/Ribasim/pull/884
* Only add flow edges to flow_dict by visr in https://github.com/Deltares/Ribasim/pull/881
* Install julia via pixi by deltamarnix in https://github.com/Deltares/Ribasim/pull/878
* Test Ribasim Python with Python 3.12 by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/891
* Add flow cost by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/886
* Don't require consecutive Node IDs by visr in https://github.com/Deltares/Ribasim/pull/885
* Pin datamodel-code-generator to 0.24 by visr in https://github.com/Deltares/Ribasim/pull/897
* Validation rules in docs by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/896
* Re-enable edge validation by visr in https://github.com/Deltares/Ribasim/pull/888
* Update PackageCompiler to 2.1.6 by visr in https://github.com/Deltares/Ribasim/pull/900
* CompatHelper: add new compat entry for MarkdownTables at version 1 for package docs, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/906
* CompatHelper: add new compat entry for DataFrames at version 1 for package docs, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/907
* CompatHelper: add new compat entry for IJulia at version 1 for package docs, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/908
* Allocation fractional flow constraints by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/854
* Allocation example by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/901
* Fix validation doc page rendering by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/910
* Update pre-commit hooks by github-actions in https://github.com/Deltares/Ribasim/pull/917
* Remove QGIS checkboxes in dataset widget by deltamarnix in https://github.com/Deltares/Ribasim/pull/919
* Move export QUARTO_PYTHON to env_setup by deltamarnix in https://github.com/Deltares/Ribasim/pull/913
* Update julia to 1.10 release by visr in https://github.com/Deltares/Ribasim/pull/926
* Make tests succeed on Linux by deltamarnix in https://github.com/Deltares/Ribasim/pull/930
* Cleanup top-level directory by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/929
* Ignore juliaup folder now that it's been moved by deltamarnix in https://github.com/Deltares/Ribasim/pull/931
* Logger writes to both Terminal and File by deltamarnix in https://github.com/Deltares/Ribasim/pull/911
* replace setuptools with hatchling by deltamarnix in https://github.com/Deltares/Ribasim/pull/933
* [fix] Apply meta renaming to spatial tables. by evetion in https://github.com/Deltares/Ribasim/pull/938
* Test models doc by Jingru923 in https://github.com/Deltares/Ribasim/pull/936

</details>