feat(dfns): add memory variable specification/schema#334
Merged
Conversation
wpbonelli
force-pushed
the
dev3
branch
6 times, most recently
from
f48946f to
b1a44e8
Compare
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
1 participant
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.
modflowapi#94 requested docs for MODFLOW API-accessible runtime variables. Currently the memory addressing scheme is not publicly documented. It's also not readily apparent what can be changed via the API and what can't (or shouldn't) be.
Add a memory variable catalog to the definition file specification. This may be of some benefit both for generating docs and code, in MF6 and
modflowapi. The spec/schema drafted here describes variables in terms of attributes like permissions, when the variable is modified, whether it's an output, etc.This adds some burden (carefully considering/defining memory variables) to package developers, but this is arguably a good thing, and it could be optional. By default (i.e. if there is no memory catalog in the DFN), variables could be made readonly. Developers could decide whether to opt into full API support.