Repository files navigation

flows2fim is a command line utility program that creates composite FIMs for different flow conditions utilizing input FIM libraries and rating curves database.flows2fim can work directly with FIM libraries stored on the cloud.

It has the following basic commands:

• controls: Given a flow file and a rating curves database, create a control table of reach flows and downstream boundary conditions.
• fim: Given a control table and a fim library folder. Create a flood inundation map for the control conditions.

The following advanced commands are available but are not commonly needed:

• validate: Given a FIM library folder and a rating curves database, validate there is one-to-one correspondence between the entries of the rating curves table and FIM library objects.

• GDAL must be installed and available in PATH

Current support is for English units. The flow values must be incfs

1. Follow install instructions atINSTALL.md

2. Get familiar usingflows2fim -h andflows2fim COMMAND -h.

3. Download Baxter sample data from s3://fimc-data/flows2fim/sample_data/v0_2_0/Baxter if you don't have a dataset already.

4. To create a control file from the 100yr flows file runflows2fim controls -db "Baxter/ripple.gpkg" -f "Baxter/flows/flows_100yr_cfs.csv" -o "Baxter/controls_100yr.csv" -sids 2821866

5. To create Depth VRT runflows2fim fim -lib "Baxter/library" -c "Baxter/controls_100yr.csv" -o "Baxter/fim_100yr.vrt"

1. Clone the repository and perform the following steps from the root of the repo.

2. Download Baxter testdata froms3://fimc-data/flows2fim/sample_data/v0_2_0/Baxter totestdata/Baxter folder.

3. Launch a docker container usingdocker compose up and run the following commands inside the container

4. Rungo run main.go controls -db "testdata/Baxter/ripple.gpkg" -f "testdata/Baxter/flows/flows_100yr_cfs.csv" -o "testdata/Baxter/controls_100yr.csv" -sids 2821866 This will create a controls.csv file

5. Rungo run main.go fim -lib "testdata/Baxter/library" -c "testdata/Baxter/controls_100yr.csv" -o "testdata/Baxter/fim_100yr.vrt" This will create a VRT file. VRT can be tested by loading in QGIS.

1. Rungo test ./... to run automated tests.

Run./scripts/build-linux-amd64.sh This will place the executable inbuilds/linux-amd64.

Installation

Examples