v2024.2.0

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: v2024.01.1...v2024.2.0

All changes

What's Changed

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

v2024.01.1

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

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

v2024.01.0

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 #936

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

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

• Declare numpy dependency of ribasim-python by @visr in #840
• Move back to latest pixi release by @Hofer-Julian in #844
• subtract allocated water from the source by @visr in #846
• Make parent relationship explicit. by @evetion in #847
• Fix problems emerging from DSD demo model by @SouthEndMusic in #848
• connectivity refactor by @SouthEndMusic in #828
• Update manifest and lockfile by @visr in #849
• Plot fix by @SouthEndMusic in #853
• Fix autodiff w.r.t. time by @SouthEndMusic in #850
• save_flow performance: avoid splatting long arrays by @visr in #856
• Fix plotting PID listen edges by @visr in #857
• update QGIS plugin docs by @visr in #855
• Update pre-commit hooks by @github-actions in #858
• Unit tests for qgis/core/model.py by @deltamarnix in #859
• Enable attach debugger by @deltamarnix in #860
• CompatHelper: bump compat for MetaGraphsNext to 0.7 for package core, (keep existing compat) by @github-actions in #868
• Disable randomly failing MacOS core tests by @visr in #872
• Document how to debug the QGIS plugin by @deltamarnix in #866
• Make QGIS tables editable by @deltamarnix in #873
• Add "allocation_network_id" to QGIS schemas by @visr in #862
• Clarify validate_model_node_ids by @visr in #867
• Fixed underscore basic-transient to basic_transient by @Fati-Mon in #879
• Don't prefix meta to fid columns. by @evetion in #874
• Add reduction factor to LinearResistance by @visr in #871

New Contributors

• @Fati-Mon made their first contribution in #879

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

v2023.11.0

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

• add missing node types to Python API docs by @visr in #707
• Modeler allocation input by @SouthEndMusic in #699
• pixi: Instantiate consistently by @Hofer-Julian in #717
• Update to python 3.12, pandas 2.1.2 by @visr in #713
• Update pre-commit hooks by @github-actions in #724
• Use actions-gh-pages by @Hofer-Julian in #725
• Back to LP solve per priority by @SouthEndMusic in #715
• Work around quarto in a cross-platform way by @Hofer-Julian in #734
• Fix rendering docs to PDF by @SouthEndMusic in #735
• docs: Fix quarto-preview by @Hofer-Julian in #741
• Fix rendering docs to PDF by @SouthEndMusic in #737
• set FractionalFlow inflow equal to outflow by @visr in #736
• Add compat entries for stdlibs by @visr in #739
• Fix test-ribasim-core by adding using Pkg; by @deltamarnix in #742
• Add installation instructions for ribasim_api by @Hofer-Julian in #749
• Streamline release process to PyPI by @Hofer-Julian in #750
• Add quarto and toml as vs code plugin recommends by @deltamarnix in #752
• Share manifests by @visr in #740
• CompatHelper: bump compat for Documenter to 1 for package docs, (keep existing compat) by @github-actions in #764
• CompatHelper: add new compat entry for SciMLBase at version 2 for package ribasim_cli, (keep existing compat) by @github-actions in #766
• CompatHelper: add new compat entry for TerminalLoggers at version 0.1 for package ribasim_cli, (keep existing compat) by @github-actions in #765
• move build code into create_binaries package by @visr in #762
• update to ruff 1.5, add notebook settings by @visr in #763
• update to pixi 0.6 by @visr in #767
• Allocation output file by @SouthEndMusic in #743
• Switch to Julia 1.10-rc1 by @visr in #738
• C4 diagrams by @deltamarnix in #770
• Ignore errors when cleaning generated testmodels by @deltamarnix in #776
• lower reltol from 1e-3 to 1e-5 by @visr in #773
• Add py.typed by @Hofer-Julian in #775
• Bump prefix-dev/setup-pixi from 0.3.0 to 0.4.0 by @dependabot in #774
• allow control of *Resistance and FractionalFlow by @visr in #716
• use quartodoc from conda-forge by @visr in #778
• mypy: Ignore missing imports by @Hofer-Julian in #779
• use TimeZones fork again by @visr in #783
• Overhaul of Python architecture by @evetion in #731
• update lockfile with pixi 0.7 by @visr in #787
• Support toml in QGIS plugin by @deltamarnix in #781
• rename ribasim.Database to ribasim.Network by @visr in #786
• Allocation diagram by @SouthEndMusic in #771
• Opt out of Aqua 0.8 persistent_tasks test by @visr in #791
• Use union types. by @evetion in #793
• Drop Python 3.9 support by @visr in #795
• Prefix extra columns with meta_ by @evetion in #794
• expose missing sections by @visr in #796
• Support arrow input. by @evetion in #798
• Bump prefix-dev/setup-pixi from 0.4.0 to 0.4.1 by @dependabot in #804
• Run Julia tests in parallel by @visr in #803
• Add fair distribution options by @SouthEndMusic in #751
• Make new simple fig of Ribasim.jl and move complex fig to dev docs by @SouthEndMusic in #806
• Develop QGIS plugins via VS Code by @deltamarnix in #805
• More informative repr's by @Huite in #817
• Update issue templates by @evetion in #818
• QGIS plugin docs: add reference to testmodels by @visr in #820
• Use hardcoded filenames. by @evetion in #815
• Refactor allocation with MetaGraph by @SouthEndMusic in #807
• Fix QGIS plugin now that database entry is not in TOML by @Huite in #826
• fix documentation CI by @visr in #827
• fixing mypy issues for ribasim_qgis plugin by @deltamarnix in #823
• Read some interpolation tables into the Model struct by @Huite in #674
• Fix plugin for older QGIS versions and type annotations by @Huite in #831
• QGIS: fix creating new model by @visr in #829
• Fix for mypy on older QGIS by @deltamarnix in #833
• Add plugin reloader to QGIS installation by @deltamarnix in #832
• Use custom iterators to speed up inflow_ids and friends by @visr in #830
• fix pixi to v0.7.0 in GitHub Actions by @visr in #837
• Else clause in case input is valid in Subgrid constructor by @Huite in #836
• Automatically associate model output in QGIS by @deltamarnix in #835

New Contributors

• @deltamarnix made their first contribution in #742

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

v2023.10.0

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

• update wheel links, which include the version number by @visr in #624
• docs: Fix broken link by @Hofer-Julian in #625
• Add allocation subnetwork test model by @SouthEndMusic in #627
• get_tmp and formulate_flow! refactor by @SouthEndMusic in #628
• Update pre-commit hooks by @github-actions in #635
• Rename pixi task from post-install to install by @Hofer-Julian in #636
• update pixi lock file by @visr in #643
• start using isoutofdomain by @visr in #639
• add more solver options for timestepping by @visr in #641
• Numerical considerations by @SouthEndMusic in #568
• Retain the order of the schemas and generated Python code by @visr in #647
• add optional pixi metadata by @visr in #648
• Bump prefix-dev/setup-pixi from 0.2.1 to 0.3.0 by @dependabot in #651
• Multiple demands per user by @SouthEndMusic in #655
• Test Ribasim Python against multiple versions by @Hofer-Julian in #652
• Add name as column and use as visualisation in QGIS. by @evetion in #658
• add model inputs and outputs to flow output by @visr in #644
• CompatHelper: bump compat for TranscodingStreams to 0.10 for package core, (keep existing compat) by @github-actions in #670
• Docs: update download instructions and iMOD QGIS install by @visr in #664
• add release process to the docs by @visr in #668
• Add dependency on testmodel for build binary tasks by @Hofer-Julian in #672
• pixi: Instantiate build environment before building by @Hofer-Julian in #675
• pixi: Update test-ribasim-api by @Hofer-Julian in #676
• opt in to extrapolation for rating curves on DataInterpolations 4.4 by @visr in #677
• update Manifests and add core Manifest by @visr in #678
• Allocation beyond max flow by @SouthEndMusic in #663
• Using iterator optimally by @SouthEndMusic in #684
• pin TimeZones to 1.10 by @visr in #685
• strip cldr artifact before build by @visr in #687
• Skip version tests of ribasim_api by @Hofer-Julian in #689
• rename model files by @visr in #690
• Fix CLI tests by @Hofer-Julian in #691
• Move from black to ruff formatter by @Hofer-Julian in #697
• Fix nodetype for Node and Edge in load_table. by @evetion in #696
• use a TimeZones.jl fork for now by @visr in #698
• refine edge labels by @visr in #683
• Add osx-arm64 to pixi.toml by @evetion in #701
• Use old pixi.lock format by @Hofer-Julian in #702
• Revert "Use a TimeZones.jl fork for now (#698)" by @visr in #703

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

v2023.09.0

Release for the TKI collaboration day on 2023-09-26.

Added

• Support and use automatic differentiation by default. Set autodiff to true or false to control. (#550)
• User node type (#574)
• Start using pixi for package management (#594)
• Added Julia script for logging run performances (#611)

Fixed

• Add missing reduction factor for TabulatedRatingCurve, stopping outflow from empty basins despite the rating curve.
• Incorrect sorting of time-varying tables leading to misinterpretation (#597)

Changed

• breaking "Basin / forcing" has been renamed to "Basin / time" (#622)
• breaking Outlet node now only flows from a higher to a lower water level. (#549)
• Allow overwriting open GeoPackage (#569)
• Various performance improvements.

All changes

All changes

• allow overwriting open GeoPackage by @visr in #569
• Add ribasim_cli tests by @Hofer-Julian in #560
• ForwardDiff.jl automatic Jacobian by @SouthEndMusic in #550
• resolve manifests by @visr in #571
• avoid returning DiffCache through BMI by @visr in #575
• use FixedSizeDiffCache for flows by @visr in #581
• avoid allocating value vectors in get_level by @visr in #582
• Bump actions/checkout from 3 to 4 by @dependabot in #584
• remove outdated plots from README by @visr in #586
• pandas exclude version 2.1.0 by @visr in #589
• clamp reduction_factor and add it to TabulatedRatingCurve by @visr in #587
• Only gravity driven Outlet flow by @SouthEndMusic in #549
• support ComponentArrays 0.15 by @visr in #592
• migrate to python tools extensions by @visr in #596
• Move from mamba to pixi by @Hofer-Julian in #594
• Fix broken link on Quarto by @Hofer-Julian in #600
• Refactor Python code by @evetion in #580
• Sort DataFrames inplace. by @evetion in #597
• User node type by @SouthEndMusic in #574
• Bump prefix-dev/setup-pixi from 0.2.0 to 0.2.1 by @dependabot in #602
• Stop running pixi install in CI by @Hofer-Julian in #603
• Add more pixi tasks by @Hofer-Julian in #604
• use LF for all text files by @visr in #606
• Minor improvements for pixi tasks by @Hofer-Julian in #605
• Plotting nitpicks by @SouthEndMusic in #608
• add runstats utility by @visr in #611
• CompatHelper: bump compat for SciMLBase to 2 for package core, (keep existing compat) by @github-actions in #613
• Pin pixi version by @Hofer-Julian in #614
• add more julia docstrings by @visr in #607
• Trim PR template by @Hofer-Julian in #615
• rename Basin / forcing to Basin / time by @visr in #622
• bump versions before release v2023.09.0 by @visr in #623

Full Changelog: v2023.08.0...v2023.09.0

v2023.08.0

Release for the TKI collaboration day on 2023-08-30.