Ribasim

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)

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

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

New Contributors
* deltamarnix made their first contribution in https://github.com/Deltares/Ribasim/pull/742

</details>

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2023.10.0...v2023.11.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)

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

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

</details>

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2023.09.0...v2023.10.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](https://pixi.sh/) 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.

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

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

</details>

**Full Changelog**: https://github.com/Deltares/Ribasim/compare/v2023.08.0...v2023.09.0

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