-
Notifications
You must be signed in to change notification settings - Fork 178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(api, shared-data): add correctionByVolume to liquid class schema and definitions #16972
Conversation
…rrection_by_volume
…rrection_by_volume
…rrection_by_volume
…rrection_by_volume
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #16972 +/- ##
==========================================
+ Coverage 73.90% 74.00% +0.09%
==========================================
Files 43 43
Lines 3231 3250 +19
==========================================
+ Hits 2388 2405 +17
- Misses 843 845 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
|
…rrection_by_volume
There's a lot of stuff in here talking about "this adds a volume correction" but it seems like none of it says what a volume correction is and what sort of numbers one might expect in here - might be worth having a sentence in a schema description somewhere. |
@@ -31,6 +31,9 @@ | |||
LiquidHandlingPropertyByVolume = Sequence[Tuple[_NonNegativeNumber, _NonNegativeNumber]] | |||
"""Settings for liquid class settings that are interpolated by volume.""" | |||
|
|||
CorrectionByVolume = Sequence[Tuple[_NonNegativeNumber, _Number]] | |||
"""Settings for correctionByVolume, which unlike other `byVolume` properties allows negative values with volume.""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be helpful to explain what these new values mean -- e.g., is this correction ADDED or SUBTRACTED from the nominal value?
Overview
Closes AUTH-868.
This PR adds a
correctionByVolume
field to liquid class definitions in the schema, pydantic models and PAPI classes for liquid class properties. This value is similar to otherbyVolume
properties in it's schema structure and usage for volume interpolation, but unlike the other properties allows negative values to be keyed to volume.For the existing
water
definition, there is no correction so singular values of[0.0, 0.0]
were put in so that all volumes produce this result.Test Plan and Hands on Testing
Use existing schema validation and integration tests.
Changelog
correctionByVolume
property to schema, shared data models, and PAPI classescorrectionByVolume
values towater.json
Review requests
Would we want to represent water's default in another way? Any value could be used for a single interpolation point and
0.0
seems to be the most straightforward way of representing that, but I'd be open to other suggestions.Risk assessment
Low.