Main issue: hydromt_wflow release 1.0

[hboisgon]

Enhancement Description

This issue is the main issue to recap the steps and wishes for a hydromt_wflow version 1 release.
In this release, we would like to take the steps to support:

• Wflow version 1
• HydroMT version 1

Required developments

1. Create a small release to support hydromt v0.10.1

• Release xarray and numpy pin unpin numpy and xarray #330
• Code formatting Fix formatting and typos #327
• Finalise Improve demand #334
• Finalise a first version of the precipitation interpolation Use time series to create forcing files #312

2. HydroMT version 1 support

• move to hydromt version 1 model object
• check if some of the functions can be updated to use core methods (especially for grid) workflows/landuse.py > reclassify.py #2
• allow to clip wflow models Issues with wflow clipping (initial states, gauge outlet, lake csv files) #317 + inverse clipping
• review buffer values (number of cells vs distance in meter)

3. Wflow version support

• update to the new TOML structure and wflow parameters names Convert wflow v0.x toml to v1.0 toml #319
• support updating from pre-v1 TOML structure to v1 TOML structure Convert wflow v0.x toml to v1.0 toml #319
• better support updating of parameters names in the TOML file (user can defined names in the staticmaps nc and be linked to TOML) Improve behavior of setup_constant_pars #232
• add or update parameters that have been added or changed in Wflow Rename glacier parameter g_tt to g_ttm #309 Wflow v1/sediment #331

4. Documentation / testing

• Update documentation and tests with the new changes Update Documentation #351
• Improve installation guide Improve installation guide in the docs #324

Nice to have

Issues that are not required for a working support of hydromt and wflow versions 1 but good to have for hydromt_wflow itself (more or less in order of importance).

• Masking with subbasins in self.grid Masking with subcatch in grid #325
• Clarify dependencies between setup methods Clarify dependencies between setup methods in docs  #125
• Fix hanging tests and docs Github workflows for tests and doc often hang with python 3.11 on linux #271
• Preserve TOML file structure Preserve toml file structure when updating a model #79
• Review default values in the different setup methods review default values #106
• Review default values in the landuse mapping tables review landuse mapping tables #84
• Restructure docs Split examples and user guide into separate sections #250

[JoostBuitink]

Maybe good to add to the nice-to-have-list (since I see clipping is mentioned in the hydromt-v1 related issues), is support for inverse clipping (e.g. removing an upstream area from a wflow model). This is only a very minor change (see this branch main...inverse_clipping), but would be nice to have in the main branch as well at some stage!

[hboisgon]

Maybe good to add to the nice-to-have-list (since I see clipping is mentioned in the hydromt-v1 related issues), is support for inverse clipping (e.g. removing an upstream area from a wflow model). This is only a very minor change (see this branch main...inverse_clipping), but would be nice to have in the main branch as well at some stage!

If it's already developed then we can add it yes :) can you create the PR @JoostBuitink ? Then I'm able to review it :)

[JoostBuitink]

Maybe good to add to the nice-to-have-list (since I see clipping is mentioned in the hydromt-v1 related issues), is support for inverse clipping (e.g. removing an upstream area from a wflow model). This is only a very minor change (see this branch main...inverse_clipping), but would be nice to have in the main branch as well at some stage!

If it's already developed then we can add it yes :) can you create the PR @JoostBuitink ? Then I'm able to review it :)

Yes, PR is created (#336)!

[DirkEilander]

Great to see this in motion! For downstream usage of hydromt_wflow in conjunction with other hydromt plugins it would be very helpful if we create a patch without numpy/xarray pins following hydromt v0.10.1. I'm happy to see this also in the list above! @hboisgon Is there a timeline on the open issues mentioned under this release? Thanks!

[hboisgon]

Hi @DirkEilander! Glad you agree with the list above :) I would like the release without numpy/xarray pin to be there next week or week after at the latest. For version 1, we will start working on it but timing will also depend on the release of Wflow version 1 itself. I put for now the milestone to end of May as an estimate.