Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with 007 data #237

Merged
merged 6 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ NGIAB provides a containerized and user-friendly solution for running the NextGe
| ![alt text](https://ciroh.ua.edu/wp-content/uploads/2022/08/CIROHLogo_200x200.png) | Funding for this project was provided by the National Oceanic & Atmospheric Administration (NOAA), awarded to the Cooperative Institute for Research to Operations in Hydrology (CIROH) through the NOAA Cooperative Agreement with The University of Alabama (NA22NWS4320003). |

[![ARM Build and push final image](https://github.com/CIROH-UA/NGIAB-CloudInfra/actions/workflows/docker_image_main_branch.yml/badge.svg)](https://github.com/CIROH-UA/NGIAB-CloudInfra/actions/workflows/docker_image_main_branch.yml)
[![X86 Build and push final image](https://github.com/CIROH-UA/NGIAB-CloudInfra/actions/workflows/docker_image_main_x86.yml/badge.svg)](https://github.com/CIROH-UA/NGIAB-CloudInfra/actions/workflows/docker_image_main_x86.yml)


**Why NextGen In A Box?**

Expand Down Expand Up @@ -94,24 +94,24 @@ cd NextGen/ngen-data

- **Linux/Mac/Windows WSL:** Use wget to download the compressed data file:
```bash
wget --no-parent https://ciroh-ua-ngen-data.s3.us-east-2.amazonaws.com/AWI-006/AWI_16_2853886_006.tar.gz
wget --no-parent https://ciroh-ua-ngen-data.s3.us-east-2.amazonaws.com/AWI-007/AWI_16_2863657_007.tar.gz
```

**Step 3: Extract and Rename**

- **All Platforms:** Extract the downloaded file and optionally rename the folder:
```bash
tar -xf AWI_16_2853886_006.tar.gz
tar -xf AWI_16_2863657_007.tar.gz
```
### Below is Optional: Rename the folder
```bash
mv AWI_16_2853886_006 my_data
mv AWI_16_2863657_007 my_data
```
Now you have successfully downloaded and prepared the sample input data in the NextGen/ngen-data directory. Remember to replace "my_data" with your preferred folder name if you choose to rename it.

### Case Study Map for the Provo River Basin, UT

![AWI_16_2853886_006](https://github.com/CIROH-UA/NGIAB-CloudInfra/blob/main/image/README/VPU16.png)
![AWI_16_2863657_007](https://github.com/CIROH-UA/NGIAB-CloudInfra/blob/main/image/README/VPU16_007.png)

**Running NGIAB**

Expand Down Expand Up @@ -139,10 +139,9 @@ sudo ./guide.sh
3. **Follow the prompts:**
- **Input Data Path:** Enter the path to your downloaded or generated input data directory. (e.g NextGen/ngen-data/my_data)
- **Run Mode:** Choose between parallel or serial execution based on your preferences.
The script pulls the related image from the awiciroh DockerHub, based on the local machine's architecture:
The script pulls the image from the awiciroh DockerHub:
```
For Mac with apple silicon (arm architecture), it pulls awiciroh/ciroh-ngen-image:latest.
For x86 machines, it pulls awiciroh/ciroh-ngen-image:latest-x86.
For both Mac with apple silicon (arm architecture) and x86 machine, it pulls awiciroh/ciroh-ngen-image:latest.
```
Example NGEN run command for parallel mode:
```bash
Expand All @@ -161,14 +160,12 @@ sudo ./guide.sh
**Output:**
- Model outputs will be saved in the outputs folder within your input data directory. (e.g '.../NextGen/ngen-data/my_data/')

After the `guide.sh` is finished, the user can decide to use the [Tethys Platform]() for visualization of the outputs (nexus and catchments). The script will pull the latest image of the [Ngiab visualizer tethys app](https://github.com/CIROH-UA/ngiab-client). It will also spin a GeoServer container in order to visualize the catchments layers (due to the size of the layer, this layer is visualized as with WMS service)
After the `guide.sh` is finished, the user can decide to use the [Teehr Evalution]() for evaluation of outputs and the [Tethys Platform]() for visualization of the outputs (nexus and catchments). The script will ask to choose each option to proceed. The Teehr evaluatoion option will pull the latest image of and run the evaluation. The next option will pull the latest image of the [Ngiab visualizer tethys app](https://github.com/CIROH-UA/ngiab-client). It will also spin a GeoServer container in order to visualize the catchments layers (due to the size of the layer, this layer is visualized as with WMS service)

```bash
Your NGEN run command is mpirun -n 8 /dmod/bin/ngen-parallel ./config/wb-2853886_subset.gpkg all ./config/wb-2853886_subset.gpkg all ./config/realization.json /ngen/ngen/data/partitions_8.json
Your NGEN run command is mpirun -n 0 /dmod/bin/ngen-parallel ./config/cat-2863657_subset.gpkg all ./config/cat-2863657_subset.gpkg all ./config/realization.json /ngen/ngen/data/partitions_0.json
If your model didn't run, or encountered an error, try checking the Forcings paths in the Realizations file you selected.
Do you want to redirect command output to /dev/null? (y/N, default: n):
y
Redirecting output to /dev/null.

real 0m44.057s
user 3m59.398s
Expand All @@ -180,9 +177,14 @@ Select an option (type a number):
2) Exit
#? 2
Have a nice day.
3 new outputs created.
Any copied files can be found here: /home/ubuntu/AWI_16_2853886_006/outputs
Visualize outputs using the Tethys Platform (https://www.tethysplatform.org/)? (y/N, default: y):
364 new outputs created.
Any copied files can be found here: /Users/benjaminlee/workspace/awi/input/AWI_16_2863657_007/outputs
Run a TEEHR Evaluation on the output (https://rtiinternational.github.io/ngiab-teehr/)? (y/N, default: y):
...
TEEHR evaluation complete.

Darwin UA-QG4YJKY 22.4.0 Darwin Kernel Version 22.4.0: Mon Mar 6 20:59:58 PST 2023; root:xnu-8796.101.5~3/RELEASE_ARM64_T6020 arm64
Visualize outputs using the Tethys Platform (https://www.tethysplatform.org/)? (Y/n, default: n):
```

### How to run NGIAB Visualizer?
Expand Down
Binary file added image/README/VPU16_007.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading