Ribasim

Added
- Support for concentration state and time for Delwaq coupling.
- Show exact commit on `ribasim --version` if it is not a release. 1479

Changed
- Optimized performance.
- Documentation has been overhauled to be more user-friendly.
- Stricter TabulatedRatingCurve validation. 1469
- Stricter Basin / profile validation. 1486
- Allocation objective function now gives equal ratios during shortage. 1386

Fixed
- Don't require unique node IDs. 1513

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

What's Changed
* Bump prefix-dev/setup-pixi from 0.6.0 to 0.7.0 by dependabot in https://github.com/Deltares/Ribasim/pull/1459
* Move to DataInterpolations v5 by visr in https://github.com/Deltares/Ribasim/pull/1464
* Fix subgrid_id in output by visr in https://github.com/Deltares/Ribasim/pull/1466
* Support macOS in our cli build by evetion in https://github.com/Deltares/Ribasim/pull/1476
* Add git status to Ribasim CLI wrapper version by evetion in https://github.com/Deltares/Ribasim/pull/1479
* Offline coupling with Delwaq by evetion in https://github.com/Deltares/Ribasim/pull/1137
* Stricter TabulatedRatingCurve validation by visr in https://github.com/Deltares/Ribasim/pull/1469
* Update Julia manifest by github-actions in https://github.com/Deltares/Ribasim/pull/1488
* Add coupling documentation. by evetion in https://github.com/Deltares/Ribasim/pull/1481
* Fix QGIS 'LevelDemand / static' schema by visr in https://github.com/Deltares/Ribasim/pull/1489
* Stronger 'Basin / profile' validation by visr in https://github.com/Deltares/Ribasim/pull/1486
* Update pixi lock file by github-actions in https://github.com/Deltares/Ribasim/pull/1487
* Support `model.to_xugrid(add_allocation = True)` by visr in https://github.com/Deltares/Ribasim/pull/1478
* Allow `missing` as static user demand by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1493
* Equal ratio allocation objective take 2 by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1386
* Run allocation at `t = 0` by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1496
* Fix github release script by visr in https://github.com/Deltares/Ribasim/pull/1492
* Test Integrating discontinuous flow by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1499
* Bump prefix-dev/setup-pixi from 0.7.0 to 0.8.0 by dependabot in https://github.com/Deltares/Ribasim/pull/1500
* Update Julia manifest by github-actions in https://github.com/Deltares/Ribasim/pull/1516
* Bump prefix-dev/setup-pixi from 0.8.0 to 0.8.1 by dependabot in https://github.com/Deltares/Ribasim/pull/1518
* Fix edge table in netCDF used for Delwaq coupling. by evetion in https://github.com/Deltares/Ribasim/pull/1519
* Allocation refactoring by Jingru923 in https://github.com/Deltares/Ribasim/pull/1503
* Fix a few issues found by JET by visr in https://github.com/Deltares/Ribasim/pull/1510
* corrected the link in Ribasim Python API readme.md by Jingru923 in https://github.com/Deltares/Ribasim/pull/1523
* Split usage to separate pages by visr in https://github.com/Deltares/Ribasim/pull/1522
* Don't trigger Github CI in a PR on merging Teamcity config commits by evetion in https://github.com/Deltares/Ribasim/pull/1528
* Write Delwaq boundary concentrations with time. Includes basin boundaries. by evetion in https://github.com/Deltares/Ribasim/pull/1524
* Don't require unique node IDs by visr in https://github.com/Deltares/Ribasim/pull/1513
* Update to Julia 1.10.4 by visr in https://github.com/Deltares/Ribasim/pull/1533
* Compute mean realized flows by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1514
* Generate basin concentration state for Delwaq by evetion in https://github.com/Deltares/Ribasim/pull/1534
* Add subgrid levels results `subgrid_level.arrow` to docs by Jingru923 in https://github.com/Deltares/Ribasim/pull/1525
* Add ipykernel to pixi deps by evetion in https://github.com/Deltares/Ribasim/pull/1542
* Don't write empty result tables by visr in https://github.com/Deltares/Ribasim/pull/1538
* Refactor docs to follow diataxis concept by evetion in https://github.com/Deltares/Ribasim/pull/1541
* Convert TeamCity xml configuration files to Kotlin by Manangka in https://github.com/Deltares/Ribasim/pull/1546
* Discrete Control performance improvements based on AGV model by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1529
* BMI docs page by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1521
* Restructure docs a bit more by visr in https://github.com/Deltares/Ribasim/pull/1548
* Include Ribasim Python API reference by visr in https://github.com/Deltares/Ribasim/pull/1553
* Improve first sentence index.qmd by gijsber in https://github.com/Deltares/Ribasim/pull/1557
* Integrate Delwaq into our Python package by evetion in https://github.com/Deltares/Ribasim/pull/1554
* Refactor all the things by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1559
* Incorporate SmoothInterpolation by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1543
* line_marker_at_central_point by DanielTollenaar in https://github.com/Deltares/Ribasim/pull/1563
* Move node equations to the node reference pages by visr in https://github.com/Deltares/Ribasim/pull/1564
* Prepare Ribasim release v2024.9.0 by visr in https://github.com/Deltares/Ribasim/pull/1561
* Use keywords for creating parameter structs by visr in https://github.com/Deltares/Ribasim/pull/1566
* Allow for meta_ prefix in spatial tables. by evetion in https://github.com/Deltares/Ribasim/pull/1568
* Auto-generate framework for Python API reference documentation by Jingru923 in https://github.com/Deltares/Ribasim/pull/1565
* Check only connected control states in FractionalFlow validation by visr in https://github.com/Deltares/Ribasim/pull/1569
* Disallow multiple outflows from Outlet at validation by visr in https://github.com/Deltares/Ribasim/pull/1570

</details>

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2024.8.0...v2024.9.0

New Contributors
* Manangka made their first contribution in https://github.com/Deltares/Ribasim/pull/1546
* DanielTollenaar made their first contribution in https://github.com/Deltares/Ribasim/pull/1563

Highlights
- Performance improvements have been a focus of this release, giving up to 10x faster runs. 1433, 1436, 1438, 1448, 1457
- Users of the QGIS plugin need to remove the old version to avoid two copies due to 1453.
- If the model does not converge and the used algorithm supports it, we log which Basins don't converge. 1440
- The CLI exe is now always in the root of the zip and makes use of the libribasim shared library. 1415
- If negative storages unadvertently happen, we now throw an error. 1425
- There is more validation on the edges. 1434

What's Changed
* Remove dutch_waterways model by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1403
* testmodelrun: Actually exit with an error code if it fails by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1405
* Use pixi task cache by Jingru923 in https://github.com/Deltares/Ribasim/pull/1407
* Bump prefix-dev/setup-pixi from 0.5.2 to 0.6.0 by dependabot in https://github.com/Deltares/Ribasim/pull/1408
* docs: Move from `subprocess.call` to `subprocess.run` by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1410
* only release if branch stars with v20 by Jingru923 in https://github.com/Deltares/Ribasim/pull/1411
* Use the same network for allocation as for the physical layer by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1399
* Use a Rust binary to expose Ribasim CLI by Hofer-Julian in https://github.com/Deltares/Ribasim/pull/1415
* Add tstops for more timeseries by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1418
* update the doc for CI by Jingru923 in https://github.com/Deltares/Ribasim/pull/1421
* Build change follow-ups by visr in https://github.com/Deltares/Ribasim/pull/1420
* Negative storage check by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1425
* Require pandera 0.18 by visr in https://github.com/Deltares/Ribasim/pull/1426
* FlowBoundary is flow direction constraining by visr in https://github.com/Deltares/Ribasim/pull/1424
* Use mean input in allocation by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1427
* Don't run allocation if not active during BMI runs by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1437
* Precalculate resistance neighbors by visr in https://github.com/Deltares/Ribasim/pull/1436
* Update vertical fluxes all at once by visr in https://github.com/Deltares/Ribasim/pull/1433
* Tighten edge validation by visr in https://github.com/Deltares/Ribasim/pull/1434
* Switch to TimeZones release 1.15 by visr in https://github.com/Deltares/Ribasim/pull/1432
* Make LevelDemand min_level and max_level optional by visr in https://github.com/Deltares/Ribasim/pull/1430
* Precalculate Basin neighbors by visr in https://github.com/Deltares/Ribasim/pull/1438
* Avoid unconstrained sections in allocation networks by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1429
* Update pixi lock file by github-actions in https://github.com/Deltares/Ribasim/pull/1443
* Update julia from 1.10.0 to 1.10.3 by visr in https://github.com/Deltares/Ribasim/pull/1445
* Update pixi lock file by github-actions in https://github.com/Deltares/Ribasim/pull/1450
* Re-enable validation in Ribasim python by Jingru923 in https://github.com/Deltares/Ribasim/pull/1446
* Bump julia-actions/cache from 1 to 2 by dependabot in https://github.com/Deltares/Ribasim/pull/1454
* Rename QGIS plugin to Ribasim by visr in https://github.com/Deltares/Ribasim/pull/1453
* Add waterquality (substance/concentration) tables by evetion in https://github.com/Deltares/Ribasim/pull/1267
* Remove Julia API reference by visr in https://github.com/Deltares/Ribasim/pull/1451
* Let Aqua check for persistent tasks by visr in https://github.com/Deltares/Ribasim/pull/1452
* Pre-calculate flow neighbor IDs for Pump, Outlet, UserDemand, FractionalFlow, TabulatedRatingCurve by visr in https://github.com/Deltares/Ribasim/pull/1448
* Redo the "stop explicitly requiring `--environment=dev` when running pixi install tasks" with new pixi release by Jingru923 in https://github.com/Deltares/Ribasim/pull/1455
* Show convergence bottleneck nodes to users by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1440
* CompatHelper: bump compat for DataInterpolations to 5 for package core, (keep existing compat) by github-actions in https://github.com/Deltares/Ribasim/pull/1458
* Increase performance by reducing lookups by SouthEndMusic in https://github.com/Deltares/Ribasim/pull/1457
* release Ribasim version 2024.8.0 by Jingru923 in https://github.com/Deltares/Ribasim/pull/1462


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

[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