Deltares / Deltares/imod-python
Refactor code for reading Modflow6 output
Open
Nobody has claimed this yet.
refactor
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
The code to read output can be separated into modules better:
- The code in
imod.mf6.out.__init__.pycan be placed into a separate module, for better findability. If we do this a requirement is thatimod.mf6.out.open_cbcandimod.mf6.open_hdsstay available. - Modflow6Simulation object received quite a fair amount of code to read output from simulations. Mostly dealing with finding the appropriate paths to files, merging partitioned data, and concatenating species. We can separate part of this into a module, instead of keeping it helper methods of the Modflow6Simulation object.
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 by reading imod.mf6.out.init.py and the Modflow6Simulation object, identifying the output-reading helpers for paths, partitioned data, and species concatenation. Done means the reading logic is separated into findable modules while imod.mf6.out.open_cbc and imod.mf6.open_hds remain available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100