Feature #2924 sal1l2_mae, PR 3 of 3 #2943
Merged
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.
Expected Differences
This PR corrects the computation of the MAE value reported in the SAL1L2 line type. Since the forecast and observation climo means may now differ, the SL1L2 MAE and SAL1L2 MAE values can now differ as well. This PR also includes updates to the Point-Stat and Appendix C chapters of the User's Guide.
Do these changes introduce new tools, command line arguments, or configuration file options? [No]
If yes, please describe:
Do these changes modify the structure of existing or add new output data types (e.g. statistic line types or NetCDF variables)? [No]
If yes, please describe:
Pull Request Testing
Built the docs several times locally to confirm that they render as expected.
Confirmed that the code compiles.
Confirmed that no diffs are flagged by the regression test for this PR.
Ran the following test being introduced by PR Feature #2924 fcst climo, PR 2 of 3 #2942 using the code for this PR:
Compared the MAE values reported in the SL1L2 and SAL1L2 line types and confirmed that they now actually do differ:
Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
Review code changes and doc updates.
Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]
Do these changes include sufficient testing updates? [No]
But the
unit_climatology_mixed.xml
test being introduced by PR Feature #2924 fcst climo, PR 2 of 3 #2942 is sufficient.Will this PR result in changes to the MET test suite? [No]
If yes, describe the new output and/or changes to the existing output:
None of the existing tests provide different forecast and observation climatology data.
If yes, create a new Update Truth METplus issue to describe them.
None of the existing tests provide different forecast and observation climatology data.
Do these changes introduce new SonarQube findings? [Yes]
If yes, please describe:
It originally flagged 4 codes smells. I addressed 3 of them, but did not do the 4th to maintain internal code consistency. However, it will still fail SonarQube because of too much duplicated new code. This is not a finding we'd chosen to address.
Please complete this pull request review by [Tues 8/13/24].
Pull Request Checklist
See the METplus Workflow for details.
Select: Reviewer(s) and Development issue
Select: Milestone as the version that will include these changes
Select: Coordinated METplus-X.Y Support project for bugfix releases or MET-X.Y.Z Development project for official releases