Skip to content

Releases: Deltares/Ribasim

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

v2024.2.0

12 Feb 22:21
11a9719
Compare
Choose a tag to compare

Added

Changed

Full Changelog: v2024.01.1...v2024.2.0

All changes

What's Changed

v2024.01.1

29 Jan 13:58
24e3a5b
Compare
Choose a tag to compare

This version allows for coupling to MODFLOW 6 with the latest imod-coupler release.

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 #977
  • Use flow_rate rather than discharge in TabulatedRatingCurve by @visr in #992

Added

  • Add update_subgrid_level to BMI functions by @Huite in #986
  • Support ribasim --version to get the version number by @Hofer-Julian in #997

Fixed

  • Fix and change table sorting in Python by @visr in #903
  • Always write fid index of Node and Edge tables by @visr in #995

Full Changelog: v2024.01.0...v2024.01.1

All changes

What's Changed

v2024.01.0

12 Jan 12:03
Compare
Choose a tag to compare

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

Full Changelog: v2023.12.0...v2024.01.0

All changes

What's Changed

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

v2023.12.0

08 Dec 13:00
2d54463
Compare
Choose a tag to compare

Allocation bugfixes and editable tables in QGIS.

Added

  • Support updating model properties in Ribasim Python (#847)
  • Support autodiff w.r.t. time (#850)
  • Make QGIS tables editable (#873)
  • Add reduction factor to LinearResistance (#871)

Fixed

  • Several allocation issues (#842)
  • Add allocation_network_id to QGIS schemas (#862)
  • Clarify validate_model_node_ids (#867)
All changes

What's Changed

New Contributors

Full Changelog: v2023.11.0...v2023.12.0

v2023.11.0

27 Nov 20:46
Compare
Choose a tag to compare

Release for the TKI collaboration day on 2023-11-28.

Added

  • Allocation of limited water supply to users (#699)
  • Add fair distribution options (#751)
  • Add ribasim to conda-forge
  • Add ribasim-api to conda-forge
  • C4 diagrams describing the code (#770, #771, #806)
  • Allow control of *Resistance and FractionalFlow (#716)
  • Support arrow input (#798)
  • Support calculating subgrid levels (#674)

Breaking

  • Overhaul of Python architecture (#731)
  • Drop Python 3.9 support (#795)
  • Require input_dir and results_dir in TOML, remove database key (#815)

Changed

  • Set FractionalFlow inflow equal to outflow (#736)
  • Lower relative tolerance from 1e-3 to 1e-5 (#773)
  • Support TOML in QGIS plugin (#781)
  • Automatically associate model output in QGIS (#835)
All changes

What's Changed

New Contributors

Full Changelog: v2023.10.0...v2023.11.0

v2023.10.0

27 Oct 12:13
cf4bce9
Compare
Choose a tag to compare

Release for the TKI collaboration day on 2023-10-31.

Added

  • Start using isoutofdomain (#639)
  • Add more solver options for timestepping (#641)
  • Numerical considerations (documentation) (#568)
  • Multiple demands per user (#655)
  • Add name as column and use as visualization in QGIS (#658)
  • Add model inputs and outputs to flow output (#644)
  • Docs: update download instructions and iMOD QGIS install (#664)

Breaking

  • Rename model files (#690)
All changes

All changes

Full Changelog: v2023.09.0...v2023.10.0