Ribasim

[DiscreteControl ](https://deltares.github.io/Ribasim/core/usage.html#sec-discrete-control) has been changed. We write all water balance terms to [results](https://deltares.github.io/Ribasim/core/usage.html#basin---basin.arrow). And `crs` is a new [required keyword](https://deltares.github.io/Ribasim/core/usage.html#configuration-file) in the TOML file. See the linked pull requests for more information.

Breaking
* Support specifying coordinate reference system (CRS) of geometries by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1339
* Support conditions on linear combinations of variables for `DiscreteControl` by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1371
* Discrete control with discrete callback by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1393

What's Changed
* Add results to xugrid by visr in https://github.com/Deltares/Ribasim/pull/1369
* Split vertical fluxes on basin by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1300
* Add remaining water balance terms to basin.arrow by visr in https://github.com/Deltares/Ribasim/pull/1367
* Write full Node table once by visr in https://github.com/Deltares/Ribasim/pull/1312
* Stop printing warnings when you can't read from database file by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1332
* Expose proper vertical flux data by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1337
* Split collecting subnetwork demand into internal sources and main network phases by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1235
* Fix allocation arrow bug by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1347
* Simplify sparsity.jl by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1349
* Disallow LevelBoundary next to ManningResistance by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1352
* Fix node ID bug in allocation by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1330
* Fix allocation flow output by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1355
* Don't add the endtime to basin.arrow results by visr in https://github.com/Deltares/Ribasim/pull/1359
* Add `Model.to_crs` method in order to reproject by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1360
* Guide documentation for cascade polder basins by Jingru923 in https://github.com/Deltares/Ribasim/pull/1258
* Sort only Edge fid so edge_id becomes more stable by visr in https://github.com/Deltares/Ribasim/pull/1363
* Add error starttime > endtime by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1379
* Run allocation first after BMI stop by visr in https://github.com/Deltares/Ribasim/pull/1390

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.6.1...v2024.7.0

What's Changed
* Remove xugrid return type annotation, bump patch version by visr in https://github.com/Deltares/Ribasim/pull/1326


**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.6.0...v2024.6.1

What's Changed
* Parallelize generate testmodels by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1309
* Error early on non globally unique node IDs by visr in https://github.com/Deltares/Ribasim/pull/1311
* Set the Node fid back to the node_id by visr in https://github.com/Deltares/Ribasim/pull/1316
* Use 32 bit signed integer on the Python side as well by visr in https://github.com/Deltares/Ribasim/pull/1315
* Minimal pixi default environment by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1322
* Add `model.to_xugrid()` by visr in https://github.com/Deltares/Ribasim/pull/1314
* Bump version number for release by visr in https://github.com/Deltares/Ribasim/pull/1323


**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.5.0...v2024.6.0

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>