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: Add code version data to outputs #1426

Merged
merged 10 commits into from
Feb 14, 2025
Merged

Conversation

RobHanna-NOAA
Copy link
Contributor

@RobHanna-NOAA RobHanna-NOAA commented Feb 9, 2025

Added two new input args to add hand version and catfim version as output columns to all four output files of FB sites and library plus SB sites and library.

The "model_version", when populated will show something similar to "HAND 4_5_11_1".
The "product_version", when populated will show something similar to "CatFIM 2_2". This reflects the interval version number that has been assigned to the CatFIM product in the past few versions.

In HydroVIS, they already have a "model_version" field but having it hear allows us for more accurate testing and debugging only. It will not be used in the HV side.

The new "product_version" field was a request from Derek and it is unknown if it will eventually become a field in HV. It may becomes a rest field but not a web / popup based field. TBD

Changes

  • tools\catfim
    • `generate_categorical_fim.py' : as described above.
    • `generate_categorical_mapping.py' : as described above.

Testing

Ran against any huc and ensure all four output files have those fields and expected values.

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)
  • n/a - 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

@RobHanna-NOAA RobHanna-NOAA self-assigned this Feb 9, 2025
@RobHanna-NOAA RobHanna-NOAA added enhancement New feature or request CatFIM NWS Flood Categorical HAND FIM labels Feb 9, 2025
@RobHanna-NOAA RobHanna-NOAA linked an issue Feb 9, 2025 that may be closed by this pull request
@RobHanna-NOAA RobHanna-NOAA marked this pull request as ready for review February 9, 2025 17:08
@EmilyDeardorff
Copy link
Contributor

I ran stage- and flow-based CatFIM with this branch and the two new columns populated as expected.

@EmilyDeardorff EmilyDeardorff self-requested a review February 13, 2025 20:23
EmilyDeardorff
EmilyDeardorff previously approved these changes Feb 13, 2025
Copy link
Contributor

@EmilyDeardorff EmilyDeardorff left a comment

Choose a reason for hiding this comment

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

Tested with stage- and flow-based CatFIM, populated new columns as expected.

@CarsonPruitt-NOAA CarsonPruitt-NOAA merged commit 3805f8f into dev Feb 14, 2025
1 check passed
@CarsonPruitt-NOAA CarsonPruitt-NOAA deleted the dev-catfim-versions branch February 14, 2025 20:40
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 enhancement New feature or request Ready_to_Merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[3pt] Add new arg for code version
3 participants