Issue #1835 sprinkling from ipf by JoerivanEngelen · Pull Request #1883 · Deltares/imod-python · GitHub

Description

Adds experimental support for SprinklingPoints class

Changes the following things:

Add SprinklingPoints class, to specify a n:1 coupling of grid cells to points.
Rename Sprinkling class to SprinklingGrid class, deprecate Sprinkling class. I had to keep the API stable as primod relies on the existence of the Sprinkling class.
As primod relies on a call to MetaSwapModel.get_pkg_type(Sprinkling), I had to modify the code somewhat, so that it returns the key of the sprinkling package regardless whether it is a SprinklingPoints or a SprinklingGrid
Add LayeredWell.from_imod5_cap_data to construct a MODFLOW6 well package from the iMOD5 data under the CAP header.
Pass on well id to the Mf6Wel class' dataset. This is used to map MODFLOW6 wells to MetaSWAP wells. It can furthermore be used in the future to add as auxiliary variable in well files in the future to have some metadata in the MODFLOW6 well file.
Refactor of the test module imod/tests/test_msw/test_sprinkling.py: Separate the test cases from the tests.
Boyscouting: Replace some calls of .values to to_numpy()
Boyscouting: Replace some calls of .values[()] to the safer enforce_scalar_data

This still has to be tested whether it works with the Peelvenen model, I'll do that in follow-up issue #1908 , where I'll also add a larger regression/user_acceptance test for our Weekly tests.

Checklist

Links to correct issue
Update changelog, if changes affect users
PR title starts with Issue #nr, e.g. Issue #737
Unit tests were added
If feature added: Added/extended example
If feature added: Added feature to API documentation
If pixi.lock was changed: Ran pixi run generate-sbom and committed changes

…with edge case

…ng, and throw TypeError when format not supported by class

…groundwater = 0, and properly order the columns of the dataframe

…. Not all of them succeed yet.

Pull request overview

Adds experimental MetaSWAP “sprinkling from IPF” support by introducing a point-based sprinkling package, while keeping the legacy Sprinkling API stable via deprecation and a new SprinklingGrid implementation. This also extends MF6 well conversion from iMOD5 CAP point data and threads stable well IDs through Mf6Wel to support coupling.

Changes:

Introduce msw.SprinklingPoints (IPF-based n:1 coupling) and msw.SprinklingGrid; deprecate msw.Sprinkling.
Extend iMOD5 CAP → MF6 well conversion to support point (IPF) inputs and propagate well id into Mf6Wel.
Refactor/expand sprinkling-related tests and modernize some .values usage to .to_numpy() / scalar enforcement.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
imod/tests/test_msw/test_sprinkling.py	Refactors/expands sprinkling tests to cover grid + new point-based sprinkling and updated API names.
imod/tests/test_msw/test_coupler_mapping.py	Updates helper to construct Mf6Wel with the new id argument.
imod/tests/test_mf6/test_mf6_wel.py	Updates CAP point-data test to validate LayeredWell.from_imod5_cap_data() now supports IPF.
imod/tests/test_mf6/test_mf6_wel_lowlvl.py	Updates low-level Mf6Wel tests to pass id.
imod/tests/fixtures/msw_model_fixture.py	Switches fixture sprinkling package to SprinklingGrid and passes well IDs to Mf6Wel.
imod/tests/fixtures/imod5_cap_data.py	Adjusts CAP sprinkling point fixture contents/column ordering.
imod/msw/utilities/imod5_converter.py	Adds typed helpers and conversion logic for sprinkling-from-points vs sprinkling-from-grids.
imod/msw/sprinkling.py	Introduces SprinklingBase, implements SprinklingGrid + new SprinklingPoints, and deprecates Sprinkling.
imod/msw/regrid/regrid_schemes.py	Adds SprinklingPointsRegridMethod for regridding the points-based sprinkling mapping grid.
imod/msw/model.py	Dispatches sprinkling import based on grid vs points and adjusts package-key resolution to remain compatible with legacy Sprinkling type usage.
imod/msw/init.py	Exposes SprinklingGrid/SprinklingPoints and keeps deprecated Sprinkling in the public API.
imod/mf6/wel.py	Replaces some .values usages, enforces scalar settings safely, and makes from_imod5_cap_data target discretization optional for point inputs.
imod/mf6/utilities/imod5_converter.py	Implements CAP point-data well extraction and makes target_dis optional (required only for grid inputs).
imod/mf6/mf6_wel_adapter.py	Adds id as optional/extra dataset data for Mf6Wel to support downstream well-to-sprinkling mapping.
docs/api/msw.rst	Updates MSW API docs to list SprinklingGrid and SprinklingPoints.
docs/api/changelog.rst	Adds changelog entries for new sprinkling-from-points support and sprinkling deprecation/rename.

Suppressed comments (1)

imod/msw/sprinkling.py:506

The TypeError message still directs users to imod.msw.Sprinkling.from_imod5_data(), but the correct non-point entry point is SprinklingGrid.from_imod5_data() (with Sprinkling being deprecated).

                Unsupported format for artificial_recharge_layer: expected a
                DataFrame for point data (IPF), got a grid (IDF). Call
                imod.msw.Sprinkling.from_imod5_data() instead.
                """

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Nice work, that's quite a significant added functionality! Just a few comments for now, mainly for clarity (for me).

Does the case were the layer is equal to zero need to be tested? (I think that's a possibility?)

Very good point! I added some test cases for this, it turned out this required some fixes, and while I was at it, I realized that I could reduce the lengthy _render method a lot, as I was basically conducting the same logic twice in different ways for points outside the svat grid and when layer = 0

I enjoyed looking at how you set up the tests, some docstrings for the grid cases (like for the point cases) would be nice to make it easier to follow what the cases are.

Fair point, I've added docstrings to these cases

LGTM, glad the review was helpful!

…rds to points falling outside the svat grid being checked on a per subunit basis

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

JoerivanEngelen added 8 commits July 8, 2026 16:32

Boyscouting: Get rid of calls to .values

66800d9

Pass id on to Mf6Wel

0473920

Support IPF wells for LayeredWell.from_imod5_cap_data

7040e13

Temp add scratch script to try out data reworking

aa1ab08

Change order of merging to first merge tables, then to grid and deal …

6405be4

…with edge case

Make script work for both subunits

fe251dd

Prototype SprinklingPoints class

42948e5

Format

87a5e02

JoerivanEngelen mentioned this pull request Jul 22, 2026

Update sprinkling class msw model #1232

Closed

5 tasks

JoerivanEngelen added 21 commits August 12, 2026 13:41

Fix mypy errors

f088ad2

Convert to set literal

eb8a9e2

Clearer varname for inside_df

308b157

Add comment

99dba8f

Add SprinklingPoints to msw namespace

157e91d

Put columns in right order

ab4815d

Start adding unittest

e5af555

Start refactoring test_module: Separate cases from tests

01f4a5e

Refactor into test for one subunit

67058da

Add SprinklingPoints to the public API

cb7458a

Migrate from_imod5_ipf logic into designated function, update docstri…

a7b1d6d

…ng, and throw TypeError when format not supported by class

Format and fix mypy issues by adding some specific typeddicts

2326477

Finalize renaming to "capacity_p", deal with extra edge case if svat_…

709038c

…groundwater = 0, and properly order the columns of the dataframe

Slightly better name

900de95

Add test to write from_imod5_data

ab665d2

Separate expected case data into separate dataclass

b7fce78

Start adding unittest for SprinklingPoints with a bunch of test cases…

4f39a69

…. Not all of them succeed yet.

Simplify case where the art grid has a mapping id in an inactive svat

4188560

Fix edge case that wasn't working and reduce code a lot

a5f01ac

Finish unittest cases and format

06f40fc

Ensure y-coords are properly oriented

919d438

Add some explanation on what is happening

351aa88

JoerivanEngelen requested review from ClaireDons and LuukBlom and a lite review from Copilot August 20, 2026 15:31

JoerivanEngelen mentioned this pull request Aug 20, 2026

Test whether SprinklingPoints produces what it should and add regression test. #1908

Open

Copilot AI reviewed Aug 20, 2026

View reviewed changes

JoerivanEngelen and others added 5 commits August 20, 2026 17:40

Fix crossref in changelog

471e6f3

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fix typo

409b3fb

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fix docstring about subunits for SprinklingGrid

df0867d

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Add experimental note

c689694

Update crossref

e31af4d

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot started reviewing on behalf of JoerivanEngelen August 20, 2026 18:06 View session

ClaireDons reviewed Aug 24, 2026

View reviewed changes

JoerivanEngelen added 10 commits August 26, 2026 15:47

Ignore errors in drop_vars(dx, dy)

ef23bea

Add test cases for MetaSwapModel.get_pkgkey()

833c7dc

Clarify comment

2628a40

Add missing docstrings to metaswap iMOD5 converter utilities

6eae1fa

Add cases for layer = 0

03009af

First version that makes tests succeed

9f87fdb

Refactor: Simplify and reduce logic duplication

5d16a90

Update test cases to be layer 1 for surface water

756feeb

Add docstrings for cases

449d7d0

Format

d683618

JoerivanEngelen requested a review from ClaireDons August 27, 2026 09:46

ClaireDons approved these changes Aug 27, 2026

View reviewed changes

JoerivanEngelen added 2 commits August 27, 2026 13:55

Update final test as well

9a1ec92

Extended docstrings, added known issue about funny behavior with rega…

4e67b43

…rds to points falling outside the svat grid being checked on a per subunit basis

JoerivanEngelen merged commit 42447ab into master Aug 27, 2026
8 checks passed

JoerivanEngelen deleted the issue_#1835_sprinkling_from_ipf branch August 27, 2026 15:25

+                      # fmt: on
+                      case_data.x_p = [2.0, 2.0, 2.0]
+                      case_data.y_p = [3.0, 2.0, 1.0]
+                      case_data.layer_p = [1, 2, 3]

Issue #1835 sprinkling from ipf by JoerivanEngelen · Pull Request #1883 · Deltares/imod-python · GitHub

Uh oh!

Issue #1835 sprinkling from ipf - #1883

Issue #1835 sprinkling from ipf#1883JoerivanEngelen merged 63 commits intomasterDeltares/imod-python:masterfrom issue_#1835_sprinkling_from_ipfDeltares/imod-python:issue_#1835_sprinkling_from_ipfCopy head branch name to clipboard

Conversation

JoerivanEngelen commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ClaireDons left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ClaireDons Aug 24, 2026

Choose a reason for hiding this comment

Uh oh!

JoerivanEngelen Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ClaireDons Aug 24, 2026

Choose a reason for hiding this comment

Uh oh!

JoerivanEngelen Aug 27, 2026

Choose a reason for hiding this comment

Uh oh!

ClaireDons left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Aug 27, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Issue #1835 sprinkling from ipf#1883
JoerivanEngelen merged 63 commits into
masterfrom
issue_#1835_sprinkling_from_ipf

JoerivanEngelen commented Jul 22, 2026 •
edited
Loading