Deltares · HendrikKok · May 1, 2024 · May 7, 2024 · May 7, 2024 · May 8, 2024
diff --git a/.gitignore b/.gitignore
@@ -142,3 +142,5 @@ examples/data
 # pixi environments
 .pixi
 
+/imod/tests/mydask.png
+/imod/tests/*_report.xml
diff --git a/docs/api/changelog.rst b/docs/api/changelog.rst
@@ -6,8 +6,85 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog`_, and this project adheres to
 `Semantic Versioning`_.
 
-0.17.2
-------
+
+[Unreleased- feature branch]
+----------------------------
+
+Fixed
+~~~~~
+- Multiple ``HorizontalFlowBarrier`` objects attached to
+  :class:`imod.mf6.GroundwaterFlowModel` are merged into a single horizontal
+  flow barrier for MODFLOW 6
+- Bug where error would be thrown when barriers in a ``HorizontalFlowBarrier``
+  would be snapped to the same cell edge. These are now summed.
+- Improve performance validation upon Package initialization
+- Improve performance writing ``HorizontalFlowBarrier`` objects
+
+Changed
+~~~~~~~
+- :class:`imod.mf6.Well` now also validates that well filter top is above well
+  filter bottom
+- :func:`open_projectfile_data` now also imports well filter top and bottom.
+- :class:`imod.mf6.Well` now logs a warning if any wells are removed during writing.
+- :class:`imod.mf6.HorizontalFlowBarrierResistance`,
+  :class:`imod.mf6.HorizontalFlowBarrierMultiplier`,
+  :class:`imod.mf6.HorizontalFlowBarrierHydraulicCharacteristic` now uses
+  vertical Polygons instead of Linestrings as geometry, and ``"ztop"`` and
+  ``"zbottom"`` variables are not used anymore. See
+  :func:`imod.prepare.linestring_to_square_zpolygons` and
+  :func:`imod.prepare.linestring_to_trapezoid_zpolygons` to generate these
+  polygons.
+- :func:`open_projectfile_data` now returns well data grouped by ipf name,
+  instead of generic, separate number per entry.
+- :class:`imod.mf6.Well` now supports wells which have a filter with zero
+  length, where ``"screen_top"`` equals ``"screen_bottom"``.
+- :class:`imod.mf6.Well` shares the same default ``minimum_thickness`` as
+  :func:`imod.prepare.assign_wells`, which is 0.05, before this was 1.0.
+- :func:`imod.prepare.allocate_drn_cells`,
+  :func:`imod.prepare.allocate_ghb_cells`,
+  :func:`imod.prepare.allocate_riv_cells`, now allocate to the first model layer
+  when elevations are above model top for all methods in
+  :func:`imod.prepare.ALLOCATION_OPTION`.
+- :meth:`imod.mf6.Well.to_mf6_pkg` got a new argument:
+  ``strict_well_validation``, which controls the behavior for when wells are
+  removed entirely during their assignment to layers. This replaces the
+  ``is_partitioned`` argument.
+
+Added
+~~~~~
+
+- :meth:`imod.mf6.Modflow6Simulation.from_imod5_data` to import imod5 data
+  loaded with :func:`imod.formats.prj.open_projectfile_data` as a MODFLOW 6
+  simulation.
+- :func:`imod.prepare.linestring_to_square_zpolygons` and
+  :func:`imod.prepare.linestring_to_trapezoid_zpolygons` to generate vertical
+  polygons that can be used to specify horizontal flow barriers, specifically:
+  :class:`imod.mf6.HorizontalFlowBarrierResistance`,
+  :class:`imod.mf6.HorizontalFlowBarrierMultiplier`,
+  :class:`imod.mf6.HorizontalFlowBarrierHydraulicCharacteristic`.
+- :class:`imod.mf6.LayeredWell` to specify wells directly to layers instead
+  assigning them with filter depths.
+- :func:`imod.prepare.cleanup_drn`, :func:`imod.prepare.cleanup_ghb`,
+  :func:`imod.prepare.cleanup_riv`, :func:`imod.prepare.cleanup_wel`. These are
+  utility functions to clean up drainage, general head boundaries, and rivers,
+  respectively.
+- :meth:`imod.mf6.Drainage.cleanup`,
+  :meth:`imod.mf6.GeneralHeadboundary.cleanup`, :meth:`imod.mf6.River.cleanup`,
+  :meth:`imod.mf6.Well.cleanup` convenience methods to call the corresponding
+  cleanup utility functions with the appropriate arguments.
+
+
+Removed
+~~~~~~~
+
+- :func:`imod.formats.prj.convert_to_disv` has been removed. This functionality
+  has been replaced by :meth:`imod.mf6.Modflow6Simulation.from_imod5_data`. To
+  convert a structured simulation to an unstructured simulation, call:
+  :meth:`imod.mf6.Modflow6Simulation.regrid_like`
+
+
+[0.17.2] - 2024-09-17
+---------------------
 
 Fixed
 ~~~~~
@@ -51,6 +128,16 @@ Changed
   :class:`imod.mf6.regrid.RiverRegridMethod`,
   :class:`imod.mf6.regrid.SpecificStorageRegridMethod`,
   :class:`imod.mf6.regrid.StorageCoefficientRegridMethod`.
+- Renamed ``imod.mf6.LayeredHorizontalFlowBarrier`` classes to
+  :class:`imod.mf6.SingleLayerHorizontalFlowBarrierResistance`,
+  :class:`imod.mf6.SingleLayerHorizontalFlowBarrierHydraulicCharacteristic`,
+  :class:`imod.mf6.SingleLayerHorizontalFlowBarrierMultiplier`,
+
+Fixed
+~~~~~
+- :func:`imod.formats.prj.open_projectfile_data` now reports the path to a
+  faulty IPF or IDF file in the error message.
+
 
 
 
@@ -292,9 +379,12 @@ Added
 - Added Python 3.11 support.
 - The GWF-GWF exchange options are derived from user created packages (NPF, OC) and
   set automatically.
-- Added the ``simulation_start_time`` and ``time_unit`` arguments. To the ``Modflow6Simulation.open_`` methods, and ``imod.mf6.out.open_`` functions. This converts the ``"time"`` coordinate to datetimes.
-- added :meth:`imod.mf6.Modflow6Simulation.mask_all_models`  to apply a mask to all models under a simulation,
-  provided the simulation is not split and the models use the same discretization. 
+- Added the ``simulation_start_time`` and ``time_unit`` arguments. To the
+  ``Modflow6Simulation.open_`` methods, and ``imod.mf6.out.open_`` functions.
+  This converts the ``"time"`` coordinate to datetimes.
+- added :meth:`imod.mf6.Modflow6Simulation.mask_all_models` to apply a mask to
+  all models under a simulation, provided the simulation is not split and the
+  models use the same discretization. 
 
 
 Changed

diff --git a/docs/api/io.rst b/docs/api/io.rst
@@ -29,4 +29,3 @@ Input/output
     prj.read_projectfile
     prj.open_projectfile_data
     prj.read_timfile
-    prj.convert_to_disv
diff --git a/docs/api/mf6.rst b/docs/api/mf6.rst
@@ -70,19 +70,38 @@ Flow Packages
     Buoyancy
     ConstantHead
     Drainage
+    Drainage.mask
+    Drainage.regrid_like
+    Drainage.cleanup
     Evapotranspiration
     GeneralHeadBoundary
+    GeneralHeadBoundary.mask
+    GeneralHeadBoundary.regrid_like
+    GeneralHeadBoundary.cleanup
     HorizontalFlowBarrierHydraulicCharacteristic
     HorizontalFlowBarrierMultiplier
     HorizontalFlowBarrierResistance
+    LayeredWell
+    LayeredWell.from_imod5_data
+    LayeredWell.mask
+    LayeredWell.regrid_like
+    LayeredWell.to_mf6_pkg
     InitialConditions
     NodePropertyFlow
     Recharge
     River
+    River.mask
+    River.regrid_like
+    River.cleanup
     SpecificStorage
     StorageCoefficient
     UnsaturatedZoneFlow
     Well
+    Well.cleanup
+    Well.from_imod5_data
+    Well.mask
+    Well.regrid_like
+    Well.to_mf6_pkg
     WellDisStructured
     WellDisVertices
 

diff --git a/docs/api/prepare.rst b/docs/api/prepare.rst
@@ -25,6 +25,9 @@ Prepare model input
     zonal_aggregate_polygons
     zonal_aggregate_raster
 
+    linestring_to_square_zpolygons
+    linestring_to_trapezoid_zpolygons
+
     assign_wells
 
     get_lower_active_grid_cells
@@ -44,3 +47,8 @@ Prepare model input
     distribute_drn_conductance
     distribute_ghb_conductance
     distribute_riv_conductance
+
+    cleanup_drn
+    cleanup_ghb
+    cleanup_riv
+    cleanup_wel
diff --git a/examples/imod5-backwards-compatibility/imod5_conversion.py b/examples/imod5-backwards-compatibility/imod5_conversion.py
diff --git a/examples/mf6/different_ways_to_regrid_models.py b/examples/mf6/different_ways_to_regrid_models.py
@@ -100,10 +100,10 @@
 # because initializing a regridder is costly.
 
 regridder_types = NodePropertyFlowRegridMethod(k=(RegridderType.CENTROIDLOCATOR,))
-regrid_context = RegridderWeightsCache()
+regrid_cache = RegridderWeightsCache()
 npf_regridded = model["npf"].regrid_like(
     target_grid=target_grid,
-    regrid_context=regrid_context,
+    regrid_cache=regrid_cache,
     regridder_types=regridder_types,
 )
 new_model["npf"] = npf_regridded

diff --git a/examples/user-guide/08-regridding.py b/examples/user-guide/08-regridding.py
@@ -191,9 +191,9 @@
 # undergo custom regridding at this stage.
 from imod.mf6.utilities.regrid import RegridderWeightsCache
 
-regrid_context = RegridderWeightsCache()
+regrid_cache = RegridderWeightsCache()
 
-regrid_context
+regrid_cache
 
 # %%
 # Regrid the recharge package with a custom regridder. In this case we opt
@@ -206,7 +206,7 @@
 
 regridded_recharge = original_rch_package.regrid_like(
     target_grid,
-    regrid_context=regrid_context,
+    regrid_cache=regrid_cache,
     regridder_types=regridder_types,
 )
 

diff --git a/imod/formats/ipf.py b/imod/formats/ipf.py
@@ -17,6 +17,7 @@
 import pandas as pd
 
 import imod
+from imod.util.time import to_pandas_datetime_series
 
 
 def _infer_delimwhitespace(line, ncol):
@@ -230,15 +231,7 @@ def read_associated(path, kwargs={}):
 
     if nrow > 0 and itype == 1:
         time_column = colnames[0]
-        len_date = len(df[time_column].iloc[0])
-        if len_date == 14:
-            df[time_column] = pd.to_datetime(df[time_column], format="%Y%m%d%H%M%S")
-        elif len_date == 8:
-            df[time_column] = pd.to_datetime(df[time_column], format="%Y%m%d")
-        else:
-            raise ValueError(
-                f"{path.name}: datetime format must be yyyymmddhhmmss or yyyymmdd"
-            )
+        df[time_column] = to_pandas_datetime_series(df[time_column])
     return df