Skip to content

rename stress_period_data to period_data - #540

Merged
wpbonelli merged 1 commit into
modflowpy:developfrom
wpbonelli:period-data
Nov 5, 2026
Merged

wpbonelli merged 1 commit into
modflowpy:developfrom
wpbonelli:period-data

Conversation

@wpbonelli

Copy link
Copy Markdown
Member

this is more correct since not all period data is a stress

flopy3's stress_period_data stays accepted, with a deprecation warning, as an alias on the classes whose flopy3 class takes it. The flopy3 adapter keeps its flopy3 names, and the DFNs their own: codegen maps the DFN's stress_period_data to period_data.

External list file names follow the field, so they're now <model>_<pkg>_period_data_p<n>.<ext>

Every package's period list is now period_data, and its row class
PeriodData, across codegen, generated classes and grammars, tests,
examples and docs. Generated modules and grammars are from codegen at the
pinned DFN commit.

flopy3's stress_period_data stays accepted, with a deprecation warning, as
a Legacy alias on the classes whose flopy3 class takes it, and on CHF's and
OLF's stress packages, which flopy3 doesn't have yet. The flopy3 adapter
keeps its flopy3 names, and the DFNs their own: codegen maps the DFN's
stress_period_data to period_data.

External list file names follow the field, so they're now
<model>_<pkg>_period_data_p<n>.<ext>.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@wpbonelli wpbonelli added this to the MMP milestone Nov 5, 2026
@wpbonelli
wpbonelli marked this pull request as ready for review November 5, 2026 18:35
@wpbonelli
wpbonelli merged commit 379b761 into modflowpy:develop Nov 5, 2026
18 checks passed
@wpbonelli
wpbonelli deleted the period-data branch November 5, 2026 18:49
wpbonelli added a commit that referenced this pull request Nov 6, 2026
Undo #540's rename, a stress period is MODFLOW's unit of time, not a concept specific to stress packages
wpbonelli added a commit to wpbonelli/pyphoenix-project that referenced this pull request Nov 6, 2026
period_data, WorkspaceComponent, kper and <name>_kper in the live plans,
keeping the old names only where they're flopy3's or a record of a decision.
A period list's sparse dim stays entry, with the reasons in representation.md,
and the name for other lists' dims is open. The audit's renames are done.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
wpbonelli added a commit to wpbonelli/pyphoenix-project that referenced this pull request Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant