Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.54 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.54 KB
Raw

ripple1d

CI Documentation Status Release PyPI version

Utilities for repurposing HEC-RAS models for use in the production of Flood Inundation Maps (FIMs) and rating curves for use in near-real time flood forecasting on the NOAA National Water Model network. Go to ReadTheDocs for more information on ripple1d.

Contents

  • api : Source code for the Flask API and Huey queueing system for managing parallel compute.
  • ripple1d: Source code for the ripple1d library.
  • tests: Unit tests.up

Requirements

OS Dependency: Ripple requires Python version >=3.10 and a Windows environment with Desktop Experience (GUI, not a headless Windows server) and HEC-RAS installed (currently version 6.3.1 is supported).

Installing Ripple

NOTE: Using a python virtual environment is not required but is highly recommended.

Using pip

Activate virtual environment as shown below and install the ripple1d package using pip using PowerShell:

    pip install ripple1d

Verify the Installation

Verify the installation by importing ripple1d in a Python shell:

    python
    >>> import ripple1d
    >>> print(ripple1d.__version__)

Credits and References

  1. Office of Water Prediction (OWP)
  2. Dewberry
  3. Raytheon
  4. Earth Resources Technology, Inc.
  5. ras2fim
  6. USACE HEC-RAS
  7. NOAA National Water Model (NWM)

Special Thanks to: David Bascom (FEMA), Christina Lindemer (FEMA), Dave Rosa (FEMA), Paul Rooney (FEMA), Julia Signell and Dan Pilone of Element84, and the developers of STAC.