feat: value_unit_pair module
#95
Merged
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
hellkite500
requested changes
Feb 6, 2024
python/ngen_conf/src/ngen/config/init_config/value_unit_pair.py
Outdated
Show resolved
Hide resolved
| U = TypeVar("U") | ||
|
|
||
|
|
||
| _VAL_UNIT_RE = re.compile(r"(.*)\[(.*)\]") |
There was a problem hiding this comment.
Not that I think we should now, but may want to consider more restrictive regex here in the future...especially considering captures which have spaces, non-standard characters, ect. This may be impossible to generalize and too far out of scope though -- just a passing thought.
There was a problem hiding this comment.
Yeah I agree. I didn't and don't know at this point in time what appropriate constraints to enforce here, so I left it a little open. My thinking was we could always refine this if needed.
Add `ValueUnitPair` and `ListUnitPair` classes. The former captures the concept of a value and a unit (i.e. `42[meters]`) while the latter is an extension of the concept but for a list of values. Why do we need this? BMI modules: soil freeze thaw, soil moisture profile, lgar, and CFE all use this format in their configuration files. These classes provide a way for capturing the expressed concept as pydantic models. This will enable adding the aforementioned modules to `ngen.config`.
aaraney
force-pushed
the
add-value-unit-pair
branch
from
de90749 to
8d86bf8
Compare
hellkite500
approved these changes
Mar 7, 2024
|
Thanks, @hellkite500! |
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.
Add
ValueUnitPairandListUnitPairclasses. The former captures the concept of a value and a unit (i.e.42[meters]) while the latter is an extension of the concept but for a list of values.Why do we need this? BMI modules: soil freeze thaw, soil moisture profile, lgar, and CFE all use this format in their configuration files. These classes provide a way for capturing the expressed concept as pydantic models. This will enable adding the aforementioned modules to
ngen.config.Notes
ngen.configversion bump, but this alone does not constitute a version bump.