RTX Code Release (PI-3): Initial Configuration of Near Real-time FIM Forecasting System and Services (2.3.4.2)

[taddyb]

The FIM-S team within Raytheon's NGWPC organization has been tasked with delivering an initial configuration of a near real-time forecasting system over a specified domain of interest (a 7-day historical flooding event in Coffeyville, KS). The following Pull Request is the mechanism of code delivery.

Additions

• Added the rise/ directory to Sources/
  • RISE stands for Real time Inundation mapping using the Sfincs Engine
• Added three notebooks which will be demo'd on Sept 30th, 2024 to OWP
  • 01_build_sfincs_from_nwm.ipynb
    • A Jupyter notebook walking through how one would prepare SFINCS inputs using HydroMT-SFINCS
  • 02_post_process.ipynb
    • A jupyter notebook walking through how to post-process using HydroMT-SFINCS
  • 03_evaluate_fims.ipynb
  • A notebook to evaluate the capability against HAND
    ** NOTE** The files required to run these capabilities exist in the RTX OE. This code is also set up to be tested in that specific environment
  • The files for testing are too large to live in Github
• Added a script ./run_sfincs.sh to run a SFINCS docker container (v2.0.3)
• Added the outlines of a Near Real-Time (NRT) architecture within src/rise/app
  • This NRT architecture is similar to that used by RTX Code Release (PI-3): Enhancements to Replace and Route to support enterprise hydrofabric and new NWPS api capabilities in near-real time #865
  • The code has been hard coded to point to the Coffeyville, KS flood event domain of interest
• Added a terraform/ directory to run the NRT architecture as IaC

Removals

• None

Changes

• Added lines to the .gitignore to ignore the Source/rise/data dir and ipynb checkpoints

Testing

Screenshots

Notes

Todos

Checklist

• PR has an informative and human-readable title
• Changes are limited to a single goal (no scope creep)
• Code can be automatically merged (no conflicts)
• Code follows project standards (link if applicable)
• Passes all existing automated tests
• 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
• Visually tested in supported browsers and devices (see checklist below 👇)
• Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
• Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

• Windows
• Linux
• Browser

Accessibility

• Keyboard friendly
• Screen reader friendly

Other

• Is useable without CSS
• Is useable without JS
• Flexible from small to large screens
• No linting errors or warnings
• JavaScript tests are passing

Copyright 2024 Raytheon Company

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
SUCH DAMAGE.

[taddyb]

Closing this PR as per instructions from NGWPC leadership. This code delivery has been changed to the new near_real-time_sfincs/ location: NOAA-OWP/near_real-time_sfincs#1