Issue #969 imod5 import recharge by luitjansl · Pull Request #1031 · Deltares/imod-python · GitHub

Fixes #969

Description

implements importing recharge packages from a project file. The recharge can be imported using a planar grid,
in which case it assigns the recharge to the uppermost active cell for each column.
The recharge can also be imported from a non-planar (so fully 3d) grid in which case it is just regridded to the target grid.

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

…mport_recharge

I have some comments!

review comment Co-authored-by: Joeri van Engelen <joerivanengelen@hotmail.com>

…/Deltares/imod-python into issue_#969_imod5_import_recharge

The active grid (idomain == 1) should be inserted here. This comes from the regridded discretization package. So you therefore require an extra argument to the from_imod5_data method, namely the regridded discretization package.

For an example of the API of the allocate_<pkg>_cells, see: https://deltares.github.io/imod-python/user-guide/09-topsystem.html#allocate-river-cells

done

We do not test if the regridding works now... I don't think we need to that for each package, but having one where it is tested helps I think. Could you add a test where you regrid this case to a very coarse grid?

in the latest version of this changeset we use the discretization package as the target grid, and it is much finer than the target_grid = data["khv"]["kh"] that was used earlier. So now it is regridding.
That aside, xugrid does as far as I know the same operation, whether the target grid matches the input grid exactly or not. So it goes through the same code path no matter what target grid we provide.

Some minor comments, approving in advance

I think this can be shortened to:

Suggested change

      
                    discretization_package: StructuredDiscretization,
          
                    dis_pkg: StructuredDiscretization,

As DIS is an abbreviation used by MODFLOW6 and pkg is a very common abbreviation for "package".

done

Please update docstring with extra dis_pkg/discretization_package argument.

done

This cleanup also occurs in the tests test_mf6_dis.py, please remove the ibound cleanup from these tests.

Also: You might get some increased performance by first loading the data into memory and then cleaning up ibound.

done

review comment Co-authored-by: Joeri van Engelen <joerivanengelen@hotmail.com>

luitjansl added 12 commits May 8, 2024 17:38

work started

5595422

recharge import with tests

e40f606

recharge import with tests

a88bcfb

now supports transient data

fdf5379

added test for transient

a48bb19

fixed tests

782abc5

formatting

5bc04e6

added unittests for grid functions

868aa30

reordering

bf3fb63

format

6096c8e

comments

8781c25

comments

d1d1200

luitjansl requested review from JoerivanEngelen and Manangka May 14, 2024 09:19

Merge branch 'imod5_converter_feature_branch' into issue_#969_imod5_i…

3e48a03

…mport_recharge

JoerivanEngelen requested changes May 14, 2024

View reviewed changes

Comment thread imod/typing/grid.py

Comment thread imod/mf6/rch.py Outdated

Comment thread imod/tests/test_mf6/test_mf6_rch.py Outdated

Comment thread imod/tests/test_typing/test_typing_grid.py Outdated

luitjansl and others added 6 commits May 14, 2024 16:51

Update imod/typing/grid.py

dafba74

review comment Co-authored-by: Joeri van Engelen <joerivanengelen@hotmail.com>

cleanup

4094bd2

Update imod/mf6/rch.py

e4b62b6

review comment Co-authored-by: Joeri van Engelen <joerivanengelen@hotmail.com>

cleanup

78a0f72

Merge branch 'issue_#969_imod5_import_recharge' of https://github.com…

ba5d97f

…/Deltares/imod-python into issue_#969_imod5_import_recharge

import statement

8ddb626

JoerivanEngelen reviewed May 15, 2024

View reviewed changes

JoerivanEngelen and others added 6 commits May 15, 2024 12:08

Make target grid have the appropriate dtype

da7822b

make sure planar grid is broadcasted properly

65152a2

format

a1b6c0e

cleanup tests

931bc43

review comments

7b42a46

review comments

df88a6d

JoerivanEngelen approved these changes May 21, 2024

View reviewed changes

luitjansl and others added 4 commits May 21, 2024 11:50

Update imod/tests/test_typing/test_typing_grid.py

df79783

review comment Co-authored-by: Joeri van Engelen <joerivanengelen@hotmail.com>

review comments

9d1c429

review comments

0706421

reorder fixture

4c2f5b2

luitjansl merged commit 9b9a2e3 into imod5_converter_feature_branch May 21, 2024

luitjansl deleted the issue_#969_imod5_import_recharge branch May 21, 2024 12:45

+                          # create an array indicating in which cells rch is active
+                          is_rch_cell = allocate_rch_cells(
+                              ALLOCATION_OPTION.at_first_active,
+                              target_grid,

+              @pytest.mark.usefixtures("imod5_dataset")
+              def test_planar_rch_from_imod5_constant(imod5_dataset, tmp_path):
+                  data = deepcopy(imod5_dataset)
+                  target_grid = data["khv"]["kh"]

+                  def from_imod5_data(
+                      cls,
+                      imod5_data: dict[str, dict[str, GridDataArray]],
+                      discretization_package: StructuredDiscretization,

+                      imod5_data: dict
+                          Dictionary with iMOD5 data. This can be constructed from the
+                          :func:`imod.formats.prj.open_projectfile_data` method.
+                      target_grid: GridDataArray
+                          The grid that should be used for the new package. Does not
+                          need to be identical to one of the input grids.
+                      regridder_types: dict, optional
+                          Optional dictionary with regridder types for a specific variable.
+                          Use this to override default regridding methods.

+                  data = data[0]
+                  # Fix data for ibound  as it contains floating values like 0.34, 0.25 etc.
+                  ibound = data["bnd"]["ibound"]
+                  ibound = ibound.where(ibound <= 0, 1)
+                  data["bnd"]["ibound"] = ibound
+                  _load_imod5_data_in_memory(data)
+                  return data

	discretization_package: StructuredDiscretization,
	dis_pkg: StructuredDiscretization,

Issue #969 imod5 import recharge by luitjansl · Pull Request #1031 · Deltares/imod-python · GitHub

Uh oh!

Issue #969 imod5 import recharge - #1031

Issue #969 imod5 import recharge#1031luitjansl merged 29 commits intoimod5_converter_feature_branchDeltares/imod-python:imod5_converter_feature_branchfrom issue_#969_imod5_import_rechargeDeltares/imod-python:issue_#969_imod5_import_rechargeCopy head branch name to clipboard

Conversation

luitjansl commented May 13, 2024

Description

Checklist

Uh oh!

JoerivanEngelen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoerivanEngelen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Issue #969 imod5 import recharge#1031
luitjansl merged 29 commits into
imod5_converter_feature_branchfrom
issue_#969_imod5_import_recharge