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] WIP: Update stage-based CatFIM to prevent overflooding if stage + elevation is provided in lieu of stage #1397

Draft
wants to merge 15 commits into
base: dev
Choose a base branch
from

Conversation

EmilyDeardorff
Copy link
Contributor

@EmilyDeardorff EmilyDeardorff commented Jan 7, 2025

There are some CatFIM sites where the stage values that are provided in the WRDS API actually have the water surface elevation (WSE) rather than the stage value. One site where this is true is site prdk2 in Paradise, KY. At this site, the action stage is listed as 378 ft, which has caused very intense over inundation (as showen in the "before" example below). This code update detects that this issue is occurring and subtracts the elevation from the incorrect "stage" value to produce the actual stage value. In the case of site prdk2, the listed "stage" value is 378 ft, so the gage elevation (363.19 ft) is subtracted to produce the much more reasonable stage value of 14.81 ft. This results in a much more reasonable stage-based CatFIM result, as shown in the "after" example below.

** This PR includes the changes from dev-catfim-v2-2-site-filtering, so should be merged after that one! **

Addresses vlab ticket #141569.

Changes

  • inundation-mapping/tools/catfim/generate_categorical_fim.py: Added an update to detect and fix cases where WSE is provided in lieu of stage.

Testing

  • I've tested this on site prdk2 (HUC 05110003)
  • I suggest that the reviewer tests this on site pvlk2 (HUC 05130101), because that site has an action stage listed at 995 ft.

Site prdk2 before this update:
prdk2_BEFORE_update

Site prdk2 after this update:
prdk2_after_update

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

@EmilyDeardorff EmilyDeardorff self-assigned this Jan 7, 2025
@EmilyDeardorff EmilyDeardorff added the CatFIM NWS Flood Categorical HAND FIM label Jan 7, 2025
@EmilyDeardorff EmilyDeardorff changed the title [1pt] Add workaround to stage-based CatFIM to convert WSE to stage if WSE is mistakenly provided [1pt] Update stage-based CatFIM to prevent overflooding if stage + elevation is provided in lieu of stage Jan 7, 2025
@RobHanna-NOAA RobHanna-NOAA changed the title [1pt] Update stage-based CatFIM to prevent overflooding if stage + elevation is provided in lieu of stage [1pt] WIP: Update stage-based CatFIM to prevent overflooding if stage + elevation is provided in lieu of stage Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CatFIM NWS Flood Categorical HAND FIM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[8pt] Update CatFIM to accommodate sites where the flood levels are elevations, not stages
3 participants