Repository navigation
docs(UcnFile): mention MODFLOW 6 GWT concentration file support - #2865
Open
TameTheGame wants to merge 1 commit into
Open
TameTheGame wants to merge 1 commit into
TameTheGame wants to merge 1 commit into
Conversation
UcnFile has read MODFLOW 6 GWT concentration files since modflowpy#2718, but the module summary and class notes still describe it as an MT3DMS reader. Name both file types, note that the header layout is detected from the file, and add a short GWT example. Refs modflowpy#2784
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2865 +/- ##
===========================================
+ Coverage 55.5% 73.8% +18.2%
===========================================
Files 644 659 +15
Lines 124135 132511 +8376
===========================================
+ Hits 68947 97812 +28865
+ Misses 55188 34699 -20489
🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before: the binaryfile module summary lists UcnFile as the reader for MT3DMS concentration files, and its class notes describe "a MT3D binary head file". Nothing in the docs says UcnFile also reads MODFLOW 6 GWT concentration output, which it has done since #2718 (first released in 3.11.0). Someone who keeps only the output files, as in #2784, gets no hint that this works.
After: the module summary and class notes name both MT3DMS and MODFLOW 6 GWT concentration files, the notes say the file type is detected from the first record header, and the examples show opening a GWT file.
This is a docstring-only change in flopy/utils/binaryfile/init.py. test_mf6_concentration_build_index already covers reading a GWT file with UcnFile, so I didn't add a test.
Checked locally on Windows with Python 3.11: ruff check, ruff format --check and codespell pass, and the changed docstrings render through napoleon without warnings. test_binaryfile.py passes apart from the two test_read_mf2005_freyberg cases, which need an mf2005 executable I don't have installed and fail the same way without this change. I didn't run the full suite.
On #2784: with the snippet from the issue, 3.10.0 raises EOFError on the GWT test output (gwt_mst03.ucn) and 3.11.0 reads it, so the original report looks resolved by #2718. I've used "Refs" rather than "Closes" so you can decide whether to close it.
Refs #2784