Add _salinity_match() function and unit tests
#159
Conversation
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
Introduced a new `_salinity_match()` function to find model field values that match observations by matching the observed salinity with the nearest salinity value calculated by the model. The code is based on the `_salinityMatch()` function that Karyn developed for use in notebooks like `analysis-karyn/notebooks/Evaluations /OA_PugetSound_CarbonateChemModelvsObsMatches20072024_v202111_qualcontrol_MatchbySalinity.ipynb`.
Introduced tests for the `_salinity_match()` function to verify its behaviour in various scenarios, ensuring its robustness. Added cases for missing salinity variables, successful matches, and no matching salinity, incorporating mock objects for dataset simulation.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #159 +/- ##
==========================================
+ Coverage 47.16% 48.50% +1.34%
==========================================
Files 35 36 +1
Lines 5025 5166 +141
==========================================
+ Hits 2370 2506 +136
- Misses 2655 2660 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Overview
This pull request introduces the
_salinity_match()function to enable matching of model field values to observations based on salinity. It also includes comprehensive unit tests for the function to ensure its reliability across varying scenarios.Changes
_salinity_match()function for model-to-observation comparisons, matching observed salinity with nearest model-calculated salinity._salinity_match()to handle cases such as missing variables, successful matches, or no matches. Mock objects are employed to simulate datasets.Checklist