From f1da57f935f33b94d37199a4fc531c184ba6f804 Mon Sep 17 00:00:00 2001 From: Jordan Laser Date: Tue, 24 Sep 2024 09:19:34 -0600 Subject: [PATCH] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ace8cb02..c8e6b09e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ ## Run it This example will execute a 24 hour NextGen simulation over the Palisade, Colorado watershed with CFE, SLOTH, PET, NOM, and t-route configuration distributed over 4 processes. The forcings used are the National Water Model v3 Retrospective. -``` + + First, obtain a hydrofabric file for the gage you wish to model. Check out [hfsubset](https://github.com/lynker-spatial/hfsubsetCLI) for a handy cli tool for generating geopackages. For Palisade, Colorado: ``` hfsubset -w medium_range \ @@ -19,6 +20,8 @@ hfsubset -w medium_range \ -o palisade.gpkg \ -t hl "Gages-09106150" ``` + + Then feed the hydrofabric file to ngen-datastream along with a few cli args to define the time domain and NextGen configuration. ``` ./scripts/stream.sh -s 202006200100 \ @@ -29,6 +32,8 @@ Then feed the hydrofabric file to ngen-datastream along with a few cli args to d -R $(pwd)/configs/ngen/realization_sloth_nom_cfe_pet_troute.json \ -n 4 ``` + + And that's it! Outputs will exist at `$(pwd)/data/datastream_test/ngen-run/outputs`. To see what's happening in `ngen-datastream` step-by-step, see the [breakdown document](https://github.com/CIROH-UA/ngen-datastream/blob/main/docs/BREAKDOWN.md).