Skip to content

Releases: Deltares/Ribasim

v2024.11.0

08 Oct 20:44
e09eeb5
Compare
Choose a tag to compare

This major new release contains many improvements. A new formulation allows much smaller water balance errors, which is combined with several performance improvements. Ribasim Python does more validation that was previously only done in the core. The Ribasim QGIS plugin now sets the relations between tables for easier model inspection. Adding min_upstream_level and max_downstream_level to Pump and Outlet means DiscreteControl is often no longer needed.

The most significant breaking change is making the node_id and edge_id the index of the Node and Edge table; these need to be globally unique.

Starting from this release Ribasim is labeled as beta software. Since development is currently mainly driven by applications in the Dutch water system, we expect that addition work needs to be done for general use outside the Netherlands.

For coupled simulation with MODFLOW and/or MetaSWAP, this release is part of the iMOD Coupler, specifically release v2024.4.0

Added

  • Support discrete control based on an external concentration condition. #1660
  • Add results/solver_stats.arrow with solver statistics over time. #1677
  • Add icon to ribasim.exe on Windows. #1712
  • Save QGIS styling in the model database. #1713
  • Add Delwaq coupling guide. #1619
  • Solver speedup due to backtracking relaxation. #1761
  • Reject adding a duplicate edge in Python. #1719
  • Support transient UserDemand return factor. #1727
  • Document the interpolation of input data. #1720
  • Automate Jacobian sparsity detection. #1606
  • Support specifying the edge_id as model.edge.add(a, b, edge_id=5). #1737
  • Use https://ribasim.org/ to host our documentation. #1736
  • Validate geometry types in Python. #1760
  • Add relationships between tables in QGIS. #1755
  • Support migrating from older Ribasim versions in Python. #1764
  • Add quick start guide to docs. #1787
  • Add min_upstream_level and max_downstream_level to Pump and Outlet. #1792
  • Add max_downstream_level to TabulatedRatingCurve. #1795
  • Validate edge connections in Python. #1765
  • Add low storage reduction factor to ManningResistance. #1796

Changed

  • Refactor of the core to ensure smaller water balance errors. #1819
  • Make node_id globally unique. #1717
  • Make the Node ID the index of the Node table, and Edge ID for Edge. #1737
  • Make more Python functions private. #1702
  • Put the contents of the CLI zips in a folder. #1722
  • Changed water balance error definition. #1767
  • Disallow missing priority parameter when using allocation. #1745
  • Rename Outlet's min_crest_level to min_upstream_level. #1788
  • Only allow flow under gravity in TabulatedRatingCurve. #1795
  • Use dtype_backend="pyarrow" for Pandas DataFrames. #1781

Fixed

  • Remove oscillations in ManningResistance. #1750
  • Fix GeoPandas CRS warning. #1810
All changes

What's Changed

Read more

v2024.10.0

23 Jul 17:25
2bc9f2d
Compare
Choose a tag to compare

For this release we said goodbye to the problematic FractionalFlow node, but welcome the ContinuousControl as a long requested feature.

Added

  • Control: Add ContinuousControl node type. #1602
  • Control: Support listening to flow through connector nodes. #1594
  • Validate that TabulatedRatingCurve levels are above Basin bottom. #1607
  • Validate that Outlet crest levels are above Basin bottom. #1607
  • Always show convergence bottlenecks. #1636
  • Docstrings for Ribasim Python. #1643
  • Allocate to UserDemand from directly connected Basin if possible. #1581
  • Add basin_state.arrow results. #1626
  • Also write stacktraces to ribasim.log. #1653

Changed

  • Require QGIS 3.34 (LTR) or newer for Ribasim QGIS plugin.

Fixed

  • Compatibility with latest NumPy, Pandera and PyArrow releases. #1618
  • LevelDemand can now be without min_level or max_level. #1629

Removed

  • Removed unused urban runoff variable from Basin. #1611
  • Removed unneeded static table from Terminal. #1624
  • Removed FractionalFlow node. #1616
All changes

What's Changed

Full Changelog: v2024.9.0...v2024.10.0

v2024.9.0

21 Jun 11:18
414efbe
Compare
Choose a tag to compare

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
All changes

What's Changed

Full Changelog: v2024.8.0...v2024.9.0

New Contributors

v2024.8.0

14 May 12:46
ab2630c
Compare
Choose a tag to compare

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

Full Changelog: v2024.7.0...v2024.8.0

v2024.7.0

18 Apr 07:06
a85a2b6
Compare
Choose a tag to compare

DiscreteControl has been changed. We write all water balance terms to results. And crs is a new required keyword in the TOML file. See the linked pull requests for more information.

Breaking

What's Changed

Full Changelog: v2024.6.1...v2024.7.0

v2024.6.1

26 Mar 16:18
f0d6487
Compare
Choose a tag to compare

What's Changed

  • Remove xugrid return type annotation, bump patch version by @visr in #1326

Full Changelog: v2024.6.0...v2024.6.1

v2024.6.0

26 Mar 13:07
1801024
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2024.5.0...v2024.6.0

v2024.5.0

22 Mar 13:09
f43010b
Compare
Choose a tag to compare

The biggest breaking change of this release is the refactoring of the Ribasim Python API.
You can find its usage in the examples.
The same examples with the old API can be found in this PDF.

Breaking

Changed

Full Changelog: v2024.4.0...v2024.5.1

v2024.4.0

11 Mar 14:28
Compare
Choose a tag to compare

What's Changed

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

Full Changelog: v2024.3.0...v2024.4.0

v2024.3.0

01 Mar 20:33
Compare
Choose a tag to compare

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 #1130
  • Make results.compression a Boolean by @visr in #1147
  • Support only fixed saveat intervals, set default at daily by @visr in #1155
  • Add node_id column to Node table by @Hofer-Julian in #1149
  • Remove adaptive solver config option by @visr in #1170
  • Rename User to UserDemand by @visr in #1175
  • Write ribasim_version to TOML and warn in core if it is different by @visr in #1181
  • Don't auto add meta_ prefix, error. by @visr in #1186
  • Disable the alternative object functions by @Jingru923 in #1193

Changed

Added

Full Changelog: v2024.2.0...v2024.3.0

All changes

What's Changed