Skip to content

feat(CellBudgetFile): support aux vars in get_ts() method#2568

Merged
wpbonelli merged 3 commits into
modflowpy:developfrom
wpbonelli:get-ts
Sep 17, 2025
Merged

feat(CellBudgetFile): support aux vars in get_ts() method#2568
wpbonelli merged 3 commits into
modflowpy:developfrom
wpbonelli:get-ts

Conversation

@wpbonelli

Copy link
Copy Markdown
Member

Add a variable parameter to the CellBudgetFile.get_ts() method defaulting to "q". Close #2270.

@codecov

codecov Bot commented Aug 4, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 26.92308% with 19 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.4%. Comparing base (556c088) to head (37e3695).
⚠️ Report is 45 commits behind head on develop.

Files with missing lines Patch % Lines
flopy/utils/binaryfile/__init__.py 26.9% 19 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2568      +/-   ##
===========================================
+ Coverage     55.5%    72.4%   +16.9%     
===========================================
  Files          644      667      +23     
  Lines       124135   128619    +4484     
===========================================
+ Hits         68947    93246   +24299     
+ Misses       55188    35373   -19815     
Files with missing lines Coverage Δ
flopy/utils/binaryfile/__init__.py 82.0% <26.9%> (-2.5%) ⬇️

... and 411 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@wpbonelli wpbonelli marked this pull request as ready for review August 4, 2025 17:29
@wpbonelli wpbonelli requested a review from jlarsen-usgs August 4, 2025 17:29
@wpbonelli

Copy link
Copy Markdown
Member Author

@cneyens is this close to what you had in mind?

@cneyens

cneyens commented Aug 7, 2025

Copy link
Copy Markdown

@cneyens is this close to what you had in mind?

Yes, this looks great!

@wpbonelli wpbonelli merged commit b1c8c7a into modflowpy:develop Sep 17, 2025
20 checks passed
@wpbonelli wpbonelli deleted the get-ts branch September 17, 2025 00:17
wpbonelli added a commit that referenced this pull request Jun 29, 2026
Add a 'variable' parameter (default "q") to get_data() and get_record() to allow specifying the field to extract to a 3D grid-shaped array. Previously "q" was returned unconditionally.

'variable' is only supported when full3D=True and the method's default behavior is unchanged.

sat = cbc.get_data(text="DATA-SAT", full3D=True, variable="sat")[0]
This is consistent with the existing `variable` parameter in get_ts(), added in #2568

Addresses #2774.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature: allow get_ts() to get auxiliary variables from the budget file

2 participants