Deltares / Deltares/imod-python

Output Control: support not writing specific stress periods

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

Nobody has claimed this yet.

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

Description

@tessodk ran into the issue that it's not possible to turn off certain timesteps as output control, even though MODFLOW6 supports this. Something like:

    BEGIN PERIOD 1
      SAVE BUDGET LAST
    END PERIOD
    
    # No output for stress periods 2 through 24
    BEGIN PERIOD 2
    END PERIOD
    
    BEGIN PERIOD 25
      SAVE BUDGET LAST
    END PERIOD

Would only save data for period 1 and 25. API could look something like:

save_budget = xr.DataArray(
    ["last", None, "last"], coords={"time": [<t1>, <t2>, <t25>]}, dims=("time",)
)
oc = imod.mf6.OutputControl(save_budget=save_budget)

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 imod.mf6.OutputControl and compare its behavior with the MODFLOW 6 output-control specification linked in the issue. Trace how save_budget is represented for each stress period, then add coverage for periods with no output and verify that the requested periods produce the corresponding output-control blocks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.