Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BradfordBates-NOAA authored Feb 22, 2021
1 parent 6df54a5 commit 08a4b98
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

Flood inundation mapping software configured to work with the U.S. National Water Model operated and maintained by the National Oceanic and Atmospheric Administration (NOAA) National Weather Service (NWS). This software uses the Height Above Nearest Drainage (HAND) method to generate Relative Elevation Models (REMs), Synthetic Rating Curves (SRCs), and catchment grids, which together are used to produce flood inundation maps (FIM). This repository also includes functionality to generate FIMs as well as tests to evaluate FIM prediction skill.

<br/><br/>
## Dependencies

[Docker](https://docs.docker.com/get-docker/)

<br/><br/>
## Installation

1. Install Docker : [Docker](https://docs.docker.com/get-docker/)
Expand All @@ -17,7 +15,6 @@ Flood inundation mapping software configured to work with the U.S. National Wate
4. Change group ownership of repo (needs to be redone when a new file occurs in the repo):
- Linux: `chgrp -R fim <path/to/repository>`

<br/><br/>
## Configuration

Software is configurable via parameters found in config directory. Copy files before editing and remove "template" pattern from the filename.
Expand All @@ -28,7 +25,6 @@ Make sure to set the config folder group to 'fim' recursively using the chown co
- `params_calibrated.env`
- runs calibrated mannings parameters from `mannings_calibrated.json`

<br/><br/>
## Input Data

The following input data sources should be downloaded and preprocessed prior to executing the preprocessing & hydrofabric generation code:
Expand All @@ -52,7 +48,6 @@ The following input data sources should be downloaded and preprocessed prior to

**NOTE:** We are currently working on a long-term data sharing solution. Until then, please fill out this [Google form](https://docs.google.com/forms/d/e/1FAIpQLSf4jkg3Fcfgl-zTCeuTzKleiM_5tE5qwwUvVUQrjC9DBa7Ulg/viewform) to notify us that you would like to obtain the AHPS Site Locations NWM Hydrofabric.

<br/><br/>
## Usage

1. Run Docker Container : `docker run --rm -it -v <path/to/data>:/data -v <path/to/repository>:/foss_fim <image_name>:<tag>`
Expand All @@ -66,7 +61,6 @@ The following input data sources should be downloaded and preprocessed prior to
i. To run entire domain of available data use one of the `/data/inputs/included_huc[4,6,8].lst` files
- Outputs can be found under `/data/outputs/<name_your_run>`

<br/><br/>
## Evaluate Inundation Map Performance
Once the hydrofabric has been generated from fim_run.sh for, evaluation against a benchmark dataset can be performed using binary contingency statistics. One benchmark dataset that can be used for evaluations are Base Level Engineering studies available on the FEMA Base Flood Elevation Viewer. To acquire FEMA datasets go to the FEMA Base Flood Elevation Viewer (https://webapps.usgs.gov/infrm/estbfe/) and download the file geodatabase and depth grids for a HUC. To perform an evaluation a flow forecast file is required and benchmark grids are preprocessed prior to running `run_test_case.py`.

Expand All @@ -82,7 +76,6 @@ For HUC 12090301, the benchmark datasets (-b) are the 100 year (“BLE_DEP01PCT
3. Run hydrologic evaluation (from inside Docker container): `/foss_fim/tests/run_test_case.py -r <fim_run_name/hucID> -b <name_of_test_instance_to_use> -t <test_case_id>`
- More information can be found by running `/foss_fim/tests/run_test_case.py --help`

<br/><br/>
## Dependencies

Dependencies are managed via [Pipenv](https://pipenv.pypa.io/en/latest/). To add new dependencies, from the projects's top-level directory:
Expand All @@ -101,26 +94,22 @@ and include both `Pipfile` and `Pipfile.lock` in your commits. The docker image

If you are on a machine that has a particularly slow internet connection, you may need to increase the timeout of pipenv. To do this simply add `PIPENV_INSTALL_TIMEOUT=10000000` in front of any of your pipenv commands.

<br/><br/>
## Known Issues & Getting Help

Please see the issue tracker on GitHub for known issues and for getting help.

<br/><br/>
## Getting Involved

NOAA's National Water Center welcomes anyone to contribute to the Cahaba repository to improve flood inundation mapping capabilities. Please contact Brad Bates (bradford.bates@noaa.gov) or Fernando Salas (fernando.salas@noaa.gov) to get started.

----

<br/><br/>
## Open Source Licensing Info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)

----

<br/><br/>
## Credits and References
1. Office of Water Prediction [(OWP)](https://water.noaa.gov/)
2. National Flood Interoperability Experiment [(NFIE)](https://web.corral.tacc.utexas.edu/nfiedata/)
Expand Down

0 comments on commit 08a4b98

Please sign in to comment.