Skip to content

Commit cbf2c72

Browse files
Release v1 rc2 (#604)
* updated version * updated changelog * fixed hydromt.typing import * updated pixi lock * fixed bug with string path for setting root * fixed logging test
1 parent 64e700f commit cbf2c72

5 files changed

Lines changed: 1484 additions & 1569 deletions

File tree

docs/changelog.rst

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,16 @@ All notable changes to this project will be documented in this page.
66
The format is based on `Keep a Changelog`_, and this project adheres to
77
`Semantic Versioning`_.
88

9-
Unreleased
9+
v1.0.0rc2
1010
==========
11-
TODO: merge with the Wflow.jl v1 pre-release notes below when we are ready for hydromt_wflow v1.0.0
11+
In v1.0.0rc2, lakes and reservoirs were merged into a single structure in Wflow.jl, prompting updates to related functions and parameters. Several new model components were introduced,
12+
including those for configuration, static maps, forcing, states, geoms, and various output types. The minimum supported Python version was raised to 3.11.
13+
The model root is now managed by a ModelRoot class, and model components such as config and forcing are now ModelComponent classes, with their data accessed via a data property.
14+
Component and method names were updated for clarity, including renaming "grid" to "staticmaps" and splitting or renaming several setup methods. The process for clipping a model was simplified to a single clip method.
15+
Reservoir handling was enhanced, allowing overwriting or adding reservoirs, and a combined staticgeom for all reservoirs is now created. The release also included various bug fixes,
16+
such as improved handling in upgrade_to_v1_wflow, correct addition of states in setup_floodplains, and better clipping and snapping of 1D rivers.
17+
The use of the tomlkit dependency was reverted, and the standard naming conventions were updated. Finally, the workflows.waterbodies module was renamed to workflows.reservoirs,
18+
and the release included documentation improvements and updates to example configurations.
1219

1320
Added
1421
-----
@@ -19,6 +26,8 @@ Added
1926
- geoms component ``WflowGeomsComponent``: represents Wflow staticgeoms data.
2027
- output_grid ``WflowOutputGridComponent``, output_scalar ``WflowOutputScalarComponent`` and output_csv ``WflowOutputCsvComponent`` components: represent Wflow outputs (used to be results).
2128
- **write_geoms**: added function arguments ``to_wgs84`` to convert the geometry to WGS84 before writing it to file. PR #432
29+
- Reservoirs can now overwrite or be added to existing ones in the model. PR #515
30+
- Create a combined staticgeom for all reservoirs "reservoirs.geojson". PR #515
2231

2332
Changed
2433
-------
@@ -41,19 +50,6 @@ Changed
4150
- Update values used in example yamls to new defaults used in Wflow.jl (#589)
4251
- Improve behavior of ``merge_reservoirs``, to merge values based on their ID rather than all non-missing pixels. (#597)
4352
- Rename standard names to no longer use "instantaneous" in the name (#601)
44-
45-
46-
Unreleased
47-
==========
48-
Lakes and reservoirs have been merged into one structure in Wflow.jl. We have updated our functions and parameters accordingly.
49-
50-
Added
51-
-----
52-
- Reservoirs can now overwrite or be added to existing ones in the model. PR #515
53-
- Create a combined staticgeom for all reservoirs "reservoirs.geojson". PR #515
54-
55-
Changed
56-
-------
5753
- **setup_reservoirs** has been renamed to **setup_reservoirs_simple_control** for sbm. The default output geom is meta_reservoirs_simple_control.geojson. PR #515
5854
- **setup_lakes** has been renamed to **setup_reservoirs_no_control** for sbm. Arguments of the functions have been updated as well. The default output geom is meta_reservoirs_no_control.geojson. PR #515
5955
- **setup_lakes** has been renamed to **setup_natural_reservoirs** for sediment. Arguments of the functions have been updated as well. The default output geom is meta_natural_reservoirs.geojson. PR #515
@@ -68,9 +64,6 @@ Fixed
6864
- Fix crop_factor and water_frac values for grassland in CORINE. PR #523
6965
- included ``floodplain_water_flow__manning_n_parameter`` in naming script (#529)
7066

71-
Deprecated
72-
----------
73-
7467
Removed
7568
-------
7669
- Reverted use of tomlkit (#529)

hydromt_wflow/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
major = 1
44
minor = 0
55
patch = 0
6-
suffix = ".dev"
6+
suffix = "rc2"
77

88
__version__ = f"{major}.{minor}.{patch}{suffix}"

hydromt_wflow/wflow_base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
import pyproj
1515
import xarray as xr
1616
from hydromt import hydromt_step
17-
from hydromt._typing import ModeLike
1817
from hydromt.error import NoDataStrategy
1918
from hydromt.gis import flw
2019
from hydromt.model import Model
20+
from hydromt.typing import ModeLike
2121

2222
import hydromt_wflow.utils as utils
2323
from hydromt_wflow import workflows
@@ -2177,7 +2177,7 @@ def set_root(self, root: Path | str, mode: ModeLike = "w"):
21772177
Mode to open the model root folder, by default 'w'.
21782178
Can be 'r' for read-only or 'r+' for read-write.
21792179
"""
2180-
self.root.set(root, mode=mode)
2180+
self.root.set(Path(root), mode=mode)
21812181

21822182
def get_config(
21832183
self,

0 commit comments

Comments
 (0)