Deltares / Deltares/imod-python
Skip (for now) processing species-data when opening iMOD PRJ data file
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
The Tutorial used during DSD 2025 makes use of the PRJ file iMOD5_model.prj.
This file contains the section "Species". This section is not empty, it contains "benzene",1
The function imod.prj.read_projectfile reads the PRJ file with the Species information. It includes this Species information in the function-return-data, a Dictionary.
iMOD Python is compatible with iMOD5 quantity models. It doesn't support (yet) reading the PRJ file containing a ground water quality model.
Suggestion: for now leave the Species information out of the return Dictonary to prevent causing confusion.
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 at imod.prj.read_projectfile and the linked open_projectfile_data API documentation, then inspect how the Species section is added to the returned dictionary. Done means PRJ files such as iMOD5_model.prj no longer expose Species information while the supported project data remains available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100