Represent and resolve NextGen BMI module input and output variables #105
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
aaraney
added
enhancement
aaraney
force-pushed
the
inputs-and-outputs
branch
from
8b0f7c9
to
39cfc66
Compare
This module introduces functions and abstractions for representing and resolving NextGen BMI module input and output variables. For example, this feature set enables representing a set of BMI modules and determining which outputs map to which inputs. Likewise, it enables validating that a set of modules' output variables are valid under the NextGen frameworks invariants. TODOs: - property resolve inputs that originate from the previous time step.
aaraney
force-pushed
the
inputs-and-outputs
branch
2 times, most recently
from
8cc4b63
to
d6e5bea
Compare
aaraney
force-pushed
the
inputs-and-outputs
branch
from
d6e5bea
to
0f4c292
Compare
robertbartel
approved these changes
May 1, 2024
| - only the first provided alias to an input name is used | ||
|
|
||
| The general rules NextGen enforces for input variables in a Multi-BMI formulation are: | ||
| - input names and aliases are module scoped (i.e. ok to have 2 modules with same input name) |
There was a problem hiding this comment.
- input names and aliases are module scoped (i.e. ok to have 2 modules with same input name)
Not sure what you are trying to convey with this. I initially think of aliases as formulation scoped, as they are used formulation-wide to pair with a data provider. But maybe this is not what you mean.
There was a problem hiding this comment.
Your language is more accurate. I used module here instead of formulation in an attempt to distinguish between a multi bmi formulation vs a "module?" formulation.
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.
This PR introduces the
ngen.config.model_varsmodule (open to changing the name, please make suggestions). The module introduces functions and abstractions for representing and resolving NextGen BMI module input and output variables. For example, this feature set enables representing a set of BMI modules and determining which outputs map to which inputs. Likewise, it enables validating that a set of modules' output variables are valid under the NextGen frameworks invariants.See tests for example usage.
ngen.config--0.3.0Additions
ngen.config.model_varsfunctions and abstractions for representing and resolving NextGen BMI module input and output variables. Functions of note are:resolve_model_inputs: Returns the input mappings and missing inputs for a single model.resolve_inputs_mapping: Returns the input mappings and missing inputs for a list of models (often, multi-bmi).resolve_outputs_mapping: Returns the set of invalid output names / aliases for a list of models.Todos
ngen.configversion before merging