Deltares / Deltares/imod-python
Projectfile: Support loading boundary conditions with both a steady-state as well as transient timestamps
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
Projectfiles can contain boundary conditions with both a "STEADY-STATE" timestamp as well as timestamps indicating actual transient or periodic boundary conditions. The data under the "steady-state" label is used by iMOD5 when building a steady-state simulation, or a transient simulation where the first stress period needs to be computed as steady-state.
Right now a keyerror is thrown in this case on the key "time", as the entry with timestamp "STEADY-STATE" doesn't have a "time" entry in the header because the "steady-state" timestamp is special-cased (I think).
We should fix the open_project_file function first. When this is done, we can assess whether we follow the iMOD5 path, or let the user select manually whether to use steady-state or transient timestamps. I think there is a reason for why iMOD5 has this functionality, as it is quite nice to have some special "steady-state" boundary conditions to drive the first steady-state stress periods.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the open_project_file function and reproduce the KeyError for "time" using a project file containing both a "STEADY-STATE" timestamp and transient timestamps. Trace how the special steady-state header is handled; done means the file loads without this error and the intended steady-state versus transient behavior is decided.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100