Hydromt-wflow

=========================
Small update

Fixed
-----
- Make HydroMT-Wflow **v0.4.0** conda installable

=========================
Small overhaul of internal methods and stability fixes. This version works with HydroMT **v0.9.1** onwards.

Changed
-------
- **WflowModel** and **WflowSedimentModel** now rely on `GridModel` from HydroMT
- PCRaster methods are moved to `pcrm` submodule and are deprecated as methods for the **WflowModel** class
- **read_staticgeoms**, **write_staticgeoms** and **staticgeoms** are now deprecated
- Staticgeoms methods are superseded by **read_geoms**, **write_geoms** and **geoms**
- **read_staticmaps**, **write_staticmaps** and **staticmaps** are now deprecated
- Staticmaps methods are superseded by **read_grid**, **write_grid** and **grid**

Fixed
-----
- Mainly stability fixes

=====================
Various new features and bugfixes in support of Wflow.jl v0.7.1. This version works with HydroMT v0.8.0.

Added
-----
- Support for models in CRS other than 4326. `PR 161 <https://github.com/Deltares/hydromt_wflow/pull/161>`_
- Support for elevation data other than MERIT Hydro in **setup_basemaps**.
- Add options to calculate daily Penman-Monteith potential evaporation using the pyet package. Depending on the available variables, two options are defined ``penman-monteith_tdew`` (inputs: ['temp', 'temp_min', 'temp_max', 'wind_u', 'wind_v', 'temp_dew', 'kin', 'press_msl']) and ``penman-monteith_rh_simple`` (inputs: ['temp', 'temp_min', 'temp_max', 'wind', 'rh', 'kin']).
- Support in toml for dir_input and dir_output options. `PR 140 <https://github.com/Deltares/hydromt_wflow/pull/140>`_
- Add options to calculate daily Penman-Monteith potential evaporation using the pyet package. Depending on the available variables, two options are defined ``penman-monteith_tdew`` (inputs: ['temp', 'temp_min', 'temp_max', 'wind_u', 'wind_v', 'temp_dew', 'kin', 'press_msl']) and ``penman-monteith_rh_simple`` (inputs: ['temp', 'temp_min', 'temp_max', 'wind', 'rh', 'kin']).
- In **setup_reservoirs**: Global Water Watch compatibility for determining reservoir parameters.
- In **setup_reservoirs**: All downloaded reservoir timeseries are saved to root in 1 csv file. Column headers indicate reservoir id.
- **setup_oulets**: Add map/geom of basin outlets (on river or all) and optionally updates outputs in toml file.
- **setup_config_output_timeseries**: add new variable/column to the netcf/csv output section of the toml based on a selected gauge/area map.
- **setup_gauges**: support for snapping based on a user defined max distance and snapping based on upstream area attribute.
- **setup_gauges**: gauges_fn can be both GeoDataFrame or GeoDataset (new) data_type.
- New **setup_floodplains** method, that allows the user the choose either 1D or 2D floodplains. Note: requires pyflwdir v0.5.7. `PR 123 <https://github.com/Deltares/hydromt_wflow/pull/123>`_
- In **setup_lakes**: Add option to prepare rating curve tables for lake Q-V and Q-H curves. Also updated LakeOutFlowFunc and LakeStorFunc accordingly. `PR 158 <https://github.com/Deltares/hydromt_wflow/pull/158>`_
- In **setup_lakes**: Support setting lake parameters from direct value in the lake_fn columns. `PR 158 <https://github.com/Deltares/hydromt_wflow/pull/158>`_
- In **setup_lakes**: Option to prepare controlled lake parameter maxstorage (new in Wflow.jl 0.7.0).
- New workflow **waterbodies.lakeattrs** to prepare lake parameters from lake_fn attribute and rating curve data.
- New **tables** model property including read/write: dictionnary of pandas.DataFrame with model tables (e.g. rating curves of lakes, etc.). `PR 158 <https://github.com/Deltares/hydromt_wflow/pull/158>`_
- Removed hardcoded mapping tables, and added those files an additional .yml file, which is by default read when creating a WflowModel. `PR 168 <https://github.com/Deltares/hydromt_wflow/pull/168>`_

Changed
-------
- Default tomls are now using the dir_output option to specify *run_default* folder.
- in **setup_reservoirs**: options 'usehe' and 'priorityjrc' are removed and replaced with 'timeseries_fn'. Options are ['jrc', 'gww']. By default None to use reservoir_fn data directly.
- in **setup_areamap**: name of the added map is based on column name of the vector data (col2raster) instead of name of the vector data file (area_fn). Allows to add several maps from one vector data file.

Fixed
-----
- Bugfix with wrong nodata value in the hydrography method which caused errors for model which where not based on (sub)basins `PR 144 <https://github.com/Deltares/hydromt_wflow/pull/144>`_
- Bugfix with wrong indexing in the river method that could cause memory issues `PR 147 <https://github.com/Deltares/hydromt_wflow/pull/147>`_
- fix error in **setup_reservoirs** when gdf contains no data in np.nanmax calculation for i.e. damheight 35
- write_forcing with time cftime.DatetimeNoLeap 138 by removing slicing forcing if missings (not needed)
- write_forcing automatic adjustment of starttime and endtime based on forcing content
- When clipping a model from a model with multiple forcing files, a single netcdf is made in write_forcing and the * is removed from the filename.
- Remove deprecated basin_shape method `PR 183 <https://github.com/Deltares/hydromt_wflow/pull/183>`_
- Remove FillValue Nan for lat/lon in staticmaps and forcing `PR 183 <https://github.com/Deltares/hydromt_wflow/pull/183>`_
- Fix compatibility with HydroMT v0.8.0, with updated `clip_geom/mask` functionality `PR 189 <https://github.com/Deltares/hydromt_wflow/pull/189>`_

Deprecated
----------
- The **setup_hydrodem** function has been removed, and the functionality are moved to **setup_rivers** and **setup_floodplains**

Documentation
-------------
- New **prepare_ldd** example notebook to demonstrate how to prepare flow directions and other elevation related data.

=========================
New setup_staticmaps_from_raster method and river smoothing algorithm. Correct some bugs linked to soon
deprecated staticmaps and staticgeoms objects in hydromt core to work with the new 0.6.0 release.

Added
-----
- Parameters for landuse esa_worlcover. `PR 111 <https://github.com/Deltares/hydromt_wflow/pull/111>`_
- New **setup_staticmaps_from_raster** method. `PR 128 <https://github.com/Deltares/hydromt_wflow/issues/111>`_

Changed
-------
- update forcing example with multiple forcing files 122
- New window smoothing algorithm in `setup_rivers` to avoid cells with small river length.
Set the min_rivlen_ratio argument to a value larger than zero to apply the smoothing.
Note: requires pyflwdir v0.5.6 `PR 92 <https://github.com/Deltares/hydromt_wflow/pull/92>`_

Fixed
-----
- write_forcing with time of type cftime.DatetimeNoLeap 109
- write_forcing: re-write config in case of multiple forcing files
- read_forcing with multiple files (* key in toml)
- bug in setup_gauges in update mode with crs.is_epsg_code 108
- bug in self.rivers if no staticgeoms and rivmsk is found 113
- bug in wflow_build_sediment.ini template in examples
- wrong defaults in wflow_build.ini teamplate in examples 116
- temporary fix to update staticgeoms basins+rivers in clip_staticmaps (update when moving away from deprecated staticgeoms).
- fix wrong default value for lai_fn in setup_laimaps 119

Deprecated
----------

======================
We now use rioxarray to read raster data. We recommend reinstalling your hydromt and hydromt_wflow environment including the rioxarray package.
This enables the writting of CF compliant netcdf files for wflow staticmaps.nc and inmaps.nc.
Following an update in xarray, hydromt version should be >= 0.5.0.

Fixed
-----
- correct float32 dtype for all landuse based maps (by changing values in all lookup tables to floats)
- write **CF-compliant** staticmaps.nc and inmaps.nc
- CRS issue when deriving subcatch for user defined gauges in setup_gauges
- update times in config depending on forcing date range availability in **write_forcing** methods 97

Changed
-------
- In the naming of the generated hydrodem map, it is now specified if a D4 or D8 conditionning has been applied for land cells.
- uint8 dtype *wflow_rivers* and *wflow_streamorder* maps
- except for coordinates (incl *x_out* and *y_out*) all variables are saved with at most 32 bit depth
- new dtype and nodata arguments in **setup_constant_pars**
- read boolean PCRaster maps with int type to be consistent with netcdf based maps
- use latest hydromt github version for the test environment files.
- in **setup_glaciers** predicate to intersects glacier data with model region is 'intersects' (the old 'contains' was not used anyway due to a bug in core).
- in **setup_reservoirs** and **setup_lakes** the predicate 'contains' to open data is now officially used after a bugfix in hydromt core (cf 150).

Added
-----
- nodata argument to **setup_areamap** with a default of -1 (was 0 and not user defined).

=========================

Changed
-------
- **setup_riverwidth** method **deprecated** (will be removed in future versions) in favour of setup_rivers. We suggest to remove the setup_riverwidth component from your ini files.
- **setup_rivers** calculate river width and depth based on the attributes of the new **river_geom_fn** river geometry file. We suggest adding "river_geom_fn = rivers_lin2019_v1" to the setup_rivers component of your ini files.
- In **setup_soilmaps** the interpolation of missing values (interpolate_na function) is executed on the model parameters at the model resolution, rather than on the original raw soilgrids data at higher resolution. This change will generate small differences in the parameter values, but (largely) improve memory usage.
- Possibility to use any dataset and not just the default ones for setup_laimaps, setup_lakes, setup_glaciers. See the documentation for data requirements.

Added
-----
- Possibility to write_forcing in several files based on time frequency (fn_freq argument).
- setup_hydrodem method for hydrological conditioned elevation used with "local-inertial" routing
- workflow.river.river_bathymetry method to derive river width and depth estimates.
Note that the new river width estimates are different and result in different model results.
- moved basemaps workflows (hydrography and topography) from HydroMT core. Note that HydroMT_Wflow v0.1.3 there should be used together with HydroMT v0.4.4 (not newer!)
- new ID columns for the outlets staticgeoms
- new ``index_col`` attribute to setup_gauges to choose a specific column of gauges_fn as ID for Wflow_gauges

Fixed
-----
- Calculation of lake_b parameter in setup_lakes.
- Add a minimum averaged discharge to lakes to avoid division by zero when computing lake_b.
- When writting several forcing files instead of one, their time_units should be the same to get one Wflow run (time_units option in write_forcing)
- Filter gauges that could not be snapped to river (if snap_to_river is True) in setup_gauges
- Avoid duplicates in the toml csv column for gauges
- Fill missing values in landslope with zeros within the basin mask
- prevent writing a _FillValue on the time coordinate of forcing data