Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 2024.11.0 #1880

Merged
merged 3 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -1349,7 +1349,7 @@ version = "3.6.0"
deps = ["Accessors", "Arrow", "BasicModelInterface", "CodecZstd", "ComponentArrays", "Configurations", "DBInterface", "DataInterpolations", "DataStructures", "Dates", "DiffEqBase", "DiffEqCallbacks", "EnumX", "FiniteDiff", "Graphs", "HiGHS", "IterTools", "JuMP", "Legolas", "LineSearches", "LinearSolve", "Logging", "LoggingExtras", "MetaGraphsNext", "OrdinaryDiffEqBDF", "OrdinaryDiffEqCore", "OrdinaryDiffEqLowOrderRK", "OrdinaryDiffEqNonlinearSolve", "OrdinaryDiffEqRosenbrock", "OrdinaryDiffEqSDIRK", "OrdinaryDiffEqTsit5", "PreallocationTools", "SQLite", "SciMLBase", "SparseArrays", "SparseConnectivityTracer", "StructArrays", "Tables", "TerminalLoggers", "TranscodingStreams"]
path = "core"
uuid = "aac5e3d9-0b8f-4d4f-8241-b1a7a9632635"
version = "2024.10.0"
version = "2024.11.0"

[deps.Ribasim.extensions]
RibasimMakieExt = ["Makie", "DataFrames"]
Expand Down
2 changes: 1 addition & 1 deletion build/cli/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion build/cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ribasim"
version = "2024.10.0"
version = "2024.11.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
2 changes: 1 addition & 1 deletion core/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "Ribasim"
uuid = "aac5e3d9-0b8f-4d4f-8241-b1a7a9632635"
authors = ["Deltares and contributors <ribasim.info@deltares.nl>"]
manifest = "../Manifest.toml"
version = "2024.10.0"
version = "2024.11.0"

[deps]
Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
Expand Down
2 changes: 1 addition & 1 deletion core/test/data/config_test.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ endtime = 2019-12-31
crs = "EPSG:28992"
input_dir = "../../generated_testmodels/lhm"
results_dir = "../../generated_testmodels/lhm"
ribasim_version = "2024.10.0"
ribasim_version = "2024.11.0"

[basin]
time = "basin/time.arrow"
Expand Down
2 changes: 1 addition & 1 deletion core/test/data/logging_test_loglevel_debug.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ endtime = 2019-12-31
crs = "EPSG:28992"
input_dir = "."
results_dir = "results"
ribasim_version = "2024.10.0"
ribasim_version = "2024.11.0"

[logging]
verbosity = "debug"
2 changes: 1 addition & 1 deletion core/test/data/logging_test_no_loglevel.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ endtime = 2019-12-31
crs = "EPSG:28992"
input_dir = "."
results_dir = "results"
ribasim_version = "2024.10.0"
ribasim_version = "2024.11.0"
2 changes: 1 addition & 1 deletion core/test/docs.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ crs = "EPSG:4326" # required
input_dir = "." # required
results_dir = "results" # required

ribasim_version = "2024.10.0" # required
ribasim_version = "2024.11.0" # required

# Specific tables can also go into Arrow files rather than the database.
# For large tables this can benefit from better compressed file sizes.
Expand Down
15 changes: 15 additions & 0 deletions docs/changelog.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),

## [Unreleased]

## [v2024.11.0] - 2024-10-08

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](https://deltares.github.io/iMOD-Documentation/coupler.html), specifically release [v2024.4.0](https://github.com/Deltares/imod_coupler/releases/tag/v2024.4.0)

### Added

- Support discrete control based on an external concentration condition. [#1660](https://github.com/Deltares/Ribasim/pull/1660)
Expand Down Expand Up @@ -39,6 +53,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
- Disallow missing priority parameter when using allocation. [#1745](https://github.com/Deltares/Ribasim/pull/1745)
- Rename Outlet's `min_crest_level` to `min_upstream_level`. [#1788](https://github.com/Deltares/Ribasim/pull/1788)
- Only allow flow under gravity in TabulatedRatingCurve. [#1795](https://github.com/Deltares/Ribasim/pull/1795)
- Use `dtype_backend="pyarrow"` for Pandas DataFrames. [#1781](https://github.com/Deltares/Ribasim/pull/1781)

### Fixed
- Remove oscillations in ManningResistance. [#1750](https://github.com/Deltares/Ribasim/pull/1750)
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/release.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Before starting the release process, ensure that all tests are passing and that
Determine the new version number like `2023.1.0`, filling in the current year, a bumped `MINOR` number for normal releases and a bumped `MICRO` number for non-breaking, hotfix releases.
This follows `YYYY.MINOR.MICRO` from [calver](https://calver.org/).

Create a branch that starts with `release`, like `release-2023-1.0`.
Create a branch that starts with `release`, like `release-2023.1.0`.
It needs to start with `release` to trigger extra TeamCity checks.

Update the version numbers in the repository to the new version number.
Expand Down
4 changes: 2 additions & 2 deletions pixi.lock
Original file line number Diff line number Diff line change
Expand Up @@ -29760,7 +29760,7 @@ packages:
timestamp: 1598024297745
- kind: pypi
name: ribasim
version: 2024.10.0
version: 2024.11.0
path: python/ribasim
sha256: c48692687129085ad19256cbf54c8df9853f6259b31997cc4a282fde86072751
requires_dist:
Expand Down Expand Up @@ -29794,7 +29794,7 @@ packages:
editable: true
- kind: pypi
name: ribasim-api
version: 2024.10.0
version: 2024.11.0
path: python/ribasim_api
sha256: dc882869854e0940ab3a12506f5b9508b04045793f6badb644579c43fa2b6cb9
requires_dist:
Expand Down
2 changes: 1 addition & 1 deletion pixi.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "Ribasim"
version = "2024.10.0"
version = "2024.11.0"
description = "Water resources modeling"
authors = ["Deltares and contributors <ribasim.info@deltares.nl>"]
channels = ["conda-forge"]
Expand Down
2 changes: 1 addition & 1 deletion python/ribasim/ribasim/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "2024.10.0"
__version__ = "2024.11.0"
__schema_version__ = 2

from ribasim.config import Allocation, Logging, Node, Solver
Expand Down
2 changes: 1 addition & 1 deletion python/ribasim_api/ribasim_api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "2024.10.0"
__version__ = "2024.11.0"

from ribasim_api.ribasim_api import RibasimApi

Expand Down
2 changes: 1 addition & 1 deletion ribasim_qgis/metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
name=Ribasim
qgisMinimumVersion=3.34
description=QGIS plugin to setup Ribasim models
version=2024.10.0
version=2024.11.0
author=Deltares and contributors
email=ribasim.info@deltares.nl

Expand Down
2 changes: 1 addition & 1 deletion ribasim_qgis/tests/data/simple_valid.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ endtime = 2021-01-01 00:00:00
crs = "EPSG:28992"
input_dir = "."
results_dir = "results"
ribasim_version = "2024.10.0"
ribasim_version = "2024.11.0"
2 changes: 1 addition & 1 deletion ribasim_qgis/widgets/dataset_widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ def _write_toml(self) -> None:
f'crs = "{self.ribasim_widget.crs.authid()}"\n',
'input_dir = "."\n',
'results_dir = "results"\n',
'ribasim_version = "2024.10.0"\n',
'ribasim_version = "2024.11.0"\n',
]
)

Expand Down
Loading