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

[1pt] PR: Bug fixes for test_cases #1387

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

[1pt] PR: Bug fixes for test_cases #1387

wants to merge 2 commits into from

Conversation

mluck
Copy link
Contributor

@mluck mluck commented Dec 27, 2024

Fixes two issues in test_cases:

  1. An error in synthesize_test_cases and run_test_case if any directories of the 5 benchmark sources (BLE, NWS, IFC, USGS, or ras2fim) do not exist. This issue was originally discovered and fixed in [1pt] WIP PR: Create inputs for selected HUC(s) #1178, but is being elevated to its own PR here. Fixes [1pt] Error in evaluation if a benchmark folder is missing #1386.
  2. Updated run_test_cases to accommodate levee and waterbody masking in Alaska. As part of these changes, hardcoded paths were replaced by environment variables.

Changes

  • src/bash_variables.env: Added environment variables for Alaska waterbody and levee masks and two variables to replace fixed paths in an upcoming PR ([1pt] WIP PR: Create inputs for selected HUC(s) #1178).
  • tools/
    • run_test_case.py: Fixed error if missing validation data. Updated masking data to include Alaska.
    • synthesize_test_cases.py: Fixed error if missing validation data.

Testing

Ran synthesize_test_cases.py with -m option to create metrics on a test_cases folder that was missing IFC data.

Deployment Plan (For developer use)

How does the changes affect the product?

  • Code only?
  • If applicable, has a deployment plan be created with the deployment person/team?
  • Require new or adjusted data inputs? Does it have start, end and duration code (in UTC)?
  • If new or updated data sets, has the FIM code been updated and tested with the new/adjusted data (subset is fine, but must be a subset of the new data)?
  • Require new pre-clip set?
  • Has new or updated python packages?

Issuer Checklist (For developer use)

You may update this checklist before and/or after creating the PR. If you're unsure about any of them, please ask, we're here to help! These items are what we are going to look for before merging your code.

  • Informative and human-readable title, using the format: [_pt] PR: <description>
  • Links are provided if this PR resolves an issue, or depends on another other PR
  • If submitting a PR to the dev branch (the default branch), you have a descriptive Feature Branch name using the format: dev-<description-of-change> (e.g. dev-revise-levee-masking)
  • Changes are limited to a single goal (no scope creep)
  • The feature branch you're submitting as a PR is up to date (merged) with the latest dev branch
  • pre-commit hooks were run locally
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • CHANGELOG updated with template version number, e.g. 4.x.x.x
  • Add yourself as an assignee in the PR as well as the FIM Technical Lead

Merge Checklist (For Technical Lead use only)

  • Update CHANGELOG with latest version number and merge date
  • Update the Citation.cff file to reflect the latest version number in the CHANGELOG
  • If applicable, update README with major alterations

@mluck mluck added bug Something isn't working testing Evaluation and testing related good first issue This would be well suited for a someone as a first contribution labels Dec 27, 2024
@mluck mluck self-assigned this Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue This would be well suited for a someone as a first contribution testing Evaluation and testing related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[1pt] Error in evaluation if a benchmark folder is missing
1 participant