Deltares / Deltares/imod-python

[FEATURE] - Modflow6Simulation.split: warn on spatially unchunked input

Open
#1,691 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
41
Forks
12
Avg merge
21h 8m
Merged PRs (30d)
1

Description

Related to #1686: it may be worthwhile to detect if the model to split is unchunked. As mentioned in the PR, this will lead to massive IO waste when writing the parallel partitions. I'm not sure on how best to word this.

There is also the distinction between structured and unstsructured inputs. A structured model can be trivially chunked along x and y. To solve the partition-related overhead, it would be sufficient to set the relevant encoding in a dump method.

This isn't the case for the unstructured case, where the internal topology ordering is essential. We could define a reorder method on the model, but it feels a bit messy to me. For structured data, I guess it would be a no-op. Perhaps a pragmatic solution is to allow it to be called internally (as an xugrid method) in the dump method: if the data is unstructured and not already ordered, then it ordered automatically before being written to Zarr or netCDF chunks.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Modflow6Simulation.split and the dump method, then read related issue #1686. Clarify how structured and unstructured inputs are distinguished, how ordering is represented, and whether the desired outcome is a warning, automatic chunking, or reordering. Done means the behavior and wording are agreed before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.