Skip to content
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

Feature #2545 interest_bounds #2546

Merged
merged 1 commit into from
May 18, 2023
Merged

Conversation

JohnHalleyGotway
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway commented May 17, 2023

Expected Differences

Add bound checking for the points of the MODE interest functions and update the docs.

  • 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

  • Describe testing already performed for these changes:

    Manually tested with piecewise linear interest functions with points outside the range of 0 and 1, and triggered this type of error message:
ERROR  : 
ERROR  : ModeConfInfo::parse_interest_function() -> all "angle_diff" interest function points (90, -1) must be in the range of 0 and 1.
ERROR  : 
  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

  • @davidalbo please review the code changes.

  • @j-opatz please review the documentation updates and confirm that all the GHA tests run without error or diffs.

  • 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? [Yes]
    I did not modify the unit tests in any way. We do not have tests to demonstrate expected failures which would be needed to test this change.

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Please complete this pull request review by [Fri 5/19/23].

Pull Request Checklist

See the METplus Workflow for details.

  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Development issue with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

…ise linear functions, and updated the MODE documentation accordingly.
Copy link
Contributor

@davidalbo davidalbo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The source code changes make sense and solve the problem. I approve the pull request.

Copy link
Contributor

@davidalbo davidalbo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The source code changes make sense and solve the problem. I approve the pull request.

Copy link
Contributor

@j-opatz j-opatz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation changes clear up the limitations of the interest function entries, and clearly state the new boundaries of 0 and 1. All automated testing by GHA passed, so this PR is approved.

@JohnHalleyGotway JohnHalleyGotway merged commit 77261b9 into develop May 18, 2023
@JohnHalleyGotway JohnHalleyGotway deleted the feature_2545_interest_bounds branch May 18, 2023 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Enhance MODE to bound check interest_function corner points in the range 0 to 1
3 participants