Merge pull request #77 from Deltares/prep_release

prepare release v0.1.4

docs/changelog.rst

@@ -5,26 +5,26 @@ All notable changes to this project will be documented in this page.
 The format is based on `Keep a Changelog`_, and this project adheres to
 `Semantic Versioning`_.
 
-[Unreleased]
-------------
+v0.1.4 (18 February 2022)
+-------------------------
+
+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.
+- 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
 
-Changed
-^^^^^^^
-- Moved interpolate_na function to be done only on output dataset (i.e. on the model resolution), rather then on the original data resolution. This change will generate small differences in the parameter values, but (largely) improve memory usage.
-- setup_riverwidth method deprecated (will be removed in future versions) in favour of setup_rivers.
-- setup_rivers takes an additional river_geom_fn argument with a river segment geometry file to calculate river width and depth from its attributes
-- Possibility to use any datasets and not just the default ones for setup_laimaps, setup_lakes, setup_glaciers
-
 Fixed
 ^^^^^
 - Calculation of lake_b parameter in setup_lakes.

envs/hydromt-wflow.yml

@@ -17,6 +17,7 @@ dependencies:
   - flit>=3.2
   - gdal>=3.1
   - geopandas
+  - hydromt >= 0.4.5
   - jupyter # to run examples
   - netcdf4
   - matplotlib # to run examples
@@ -27,7 +28,7 @@ dependencies:
   - pandas
   - pcraster # optional
   - pip
-  - pyflwdir>=0.5.4
+  - pyflwdir>=0.5.5
   - pygeos>=0.8
   - pytest # tests
   - pytest-cov # tests
@@ -43,5 +44,5 @@ dependencies:
   - zarr
   - pip:
     - hydroengine
-    - git+https://github.com/Deltares/hydromt.git
+    # - git+https://github.com/Deltares/hydromt.git
 

envs/test_env.yml

@@ -15,13 +15,14 @@ dependencies:
   - flit>=3.2
   - gdal>=3.1
   - geopandas
+  - hydromt >= 0.4.5
   - netcdf4
   - numba
   - numpy
   - openpyxl
   - pandas
   - pip
-  - pyflwdir>=0.5.4
+  - pyflwdir>=0.5.5
   - pygeos>=0.8
   - pytest # tests
   # - pytest-benchmark # test > unused
@@ -36,5 +37,5 @@ dependencies:
   - zarr
   - pip:
     # - hydroengine > test without for speed
-    - git+https://github.com/Deltares/hydromt.git
+    # - git+https://github.com/Deltares/hydromt.git
 

hydromt_wflow/__init__.py

@@ -2,7 +2,7 @@
 
 from os.path import join, dirname, abspath
 
-__version__ = "0.1.4.dev"
+__version__ = "0.1.4"
 
 try:
     import pcraster as pcr

pyproject.toml

@@ -9,13 +9,13 @@ authors = [
     {name = "Hélène Boisgontier", email = "[email protected]"},
 ]
 dependencies = [
-    "hydromt >=0.4.4",
+    "hydromt >=0.4.5",
     "dask",
     "geopandas >=0.8",
     "netcdf4",
     "numpy",
     "pandas",
-    "pyflwdir>=0.5.4",
+    "pyflwdir>=0.5.5",
     "pygeos",
     "rasterio",
     "scipy",
@@ -41,11 +41,11 @@ test = [
     "responses",
     "pytest>=2.7.3",
     "pytest-cov",
+    "black",
 ]
 doc = [
     "sphinx",
     "sphinx_rtd_theme",
-    "black",
 ]
 
 [project.urls]