search

Deltares / Ribasim

Water resources modeling
https://ribasim.org/
MIT License
41 stars 5 forks source link

Ribasim v2024.7.0 not working with old ribasim.toml files #1422

Closed Joris-J closed 6 months ago

Joris-J commented 6 months ago

I'm using the newest release of ribasim (v2024.7.0) to read a previously made ribasim.toml.

ribasim.Model.read(r"file_path/ribasim.toml")

I get a validation error:

_ValidationError: 1 validation error for Model crs Field required [type=missing, input_value={'starttime': datetime.da...m_primary/ribasim.toml'}, inputtype=dict] For further information visit https://errors.pydantic.dev/2.7/v/missing

I've attached the toml-file to this post (ribasim_primary.zip). I do not have this issue in v2024.6.1

visr commented 6 months ago

Thanks for the report. This is an intentional breaking change in v2024.7. At this point old TOML files are not guaranteed to work with newer Ribasim versions. The validation error for crs that is mentioned is a new required key in the TOML. For a Dutch model, you probably want to add:

crs = "EPSG:28992"

to the TOML file. This will ensure that the model will show up on top of the Netherlands when loading it into GIS software.

https://deltares.github.io/Ribasim/core/usage.html#configuration-file

There are also breaking changes to DiscreteControl in the same release. We should still update the release notes in https://github.com/Deltares/Ribasim/releases/tag/v2024.7.0 to highlight these, ideally with update instructions.

visr commented 6 months ago

I updated the release notes and breaking changes in https://github.com/Deltares/Ribasim/releases/tag/v2024.7.0 with more information. Let us know if you have trouble upgrading to the new version. I'll close this issue for now.