Improving documentation on BMI and BMI multi-formulation configuration #754
Conversation
This file contains 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
Adding/correcting details on configuration of the `variable_names_map` config param, the overall details of `bmi_multi` formulations, the constraints on variable mapping in `bmi_multi` formulations, and the details of configuring (or not) default variable values.
robertbartel
added
documentation
program--
reviewed
Mar 7, 2024
There was a problem hiding this comment.
Would it be possible to add an example of a BMI multi-formulation that has a look-back input dependency? or rather just extend the default values example to include modules?
There was a problem hiding this comment.
Sure, I've modified the example config and added a bit more description to hopefully better illustrate things.
program--
approved these changes
Mar 8, 2024
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.
Updating the BMI_MODELS.md file with better detail on variable names mapping, behavior of
bmi_multiformulation configurations, and usage (or omission) of default variable values.Additions to docstrings for wrapper provider types to clarify details regarding when they are ready to provide, which has relevance with respect to the need for default values in the OptionalWrappedDataProvider.