Skip to content

Commit

Permalink
Updated NGIAB
Browse files Browse the repository at this point in the history
  • Loading branch information
arpita0911patel committed Sep 28, 2023
1 parent f81d2f4 commit 3be5f86
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 7 deletions.
20 changes: 18 additions & 2 deletions docs/products/NextGen Framework/NWM-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ The National Water Model (NWM) is a hydrologic model developed by **the National

- NOAA Central Library Seminar Recording from OWP (Next-Generation Water Resources Modeling): https://youtu.be/DLIi3PruYxo

## Features - NWM3.0

- First time provision of NWM Total Water Level guidance for coastal areas of the Continental United States (CONUS), Hawaii and Puerto Rico / U.S. Virgin Island domains. This is accomplished via use of the Semi-implicit Cross-scale Hydroscience Integrated System Model (SCHISM) integrated within the NWM, to couple NWM freshwater discharge estimates with oceanic forcing from the Surge and Tide Operational Forecast System (STOFS) and Probabilistic Tropical Storm Surge (P-SURGE) model. Output will be provided in both NetCDF as well as Standard Hydrometeorological Exchange Format (SHEF) format. Each NetCDF file contains full TWL domain output for one output time step, while each SHEF file contains timeseries station output for the full length of each simulation.

- NWM Domain expansion to south-central Alaska (Cook Inlet, Copper River Basin, and Prince William Sound regions), enabling provision of NWM operational hydrologic model forecast guidance to this region.

- Addition of the National Blend of Models (NBM) as a forcing source for NWM CONUS medium-range forecasts and Alaska short-range and medium-range forecasts.

- Use of Multi-Radar Multi-Sensor (MRMS) precipitation as forcing for the NWM Analysis and Assimilation configuration over the Puerto Rico / U.S. Virgin Island domain.

- Ingest of RFC-supplied reservoir outflow forecasts at 77 additional locations, bringing the total of such sites to 392.

- Enhancements to the treatment of reservoirs, land surface parameters and calibration/regionalization approach leading to improvements in model skill.

## Features - NWM2.1

The NWM currently runs in four configurations:
Expand All @@ -22,18 +36,20 @@ The NWM currently runs in four configurations:

Source : https://water.noaa.gov/about/nwm

# SO...WHAT IS NEXTGEN?
# What is ngen?

- Model agnostic - NextGen is a framework designed for building and integrating models rather than a model itself.
- Data-centric standards - The framework's focus is on a data-centric process that abstracts the addition of processes and data behind a standard.
- NextGen design allows for greater flexibility and standardizationin model creation and integration.

- Github URL: [NOAA-OWP/ngen](https://github.com/NOAA-OWP/ngen)

# What is NextGen In A Box?
# What is NextGen In A Box (NGIAB)?

- NextGen National Water Resources Modeling Framework Community Release; that can be run for small set of input data rather than running conus wide.

- NGIAB is dependant on ngen repository and uses it internally.

- Github URL: [CIROH-UA/CloudInfra](https://github.com/CIROH-UA/NGIAB-CloudInfra)

- For more information, refer to the NextGen In A Box tab below.
99 changes: 94 additions & 5 deletions docs/products/NextGenInABox/NGIAB.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@
sidebar_position: 2
---

# NextGen In A Box
# NextGen In A Box (NGIAB)

NextGen National Water Resources Modeling Framework Community Release
NextGen framework-based simulations are now easy with NextGen In A Box!

- Provides capabilities to run the Next Generation National Water Resources Modeling framework on your local machine for small set of input data.
Containerized "NextGen In a Box" (NGIAB) is a community-accessible version of the NextGen National Water Resources Modeling Framework.

The key accomplishment of this research effort is the development and dissemination of NextGen In a Box (NGIAB), a community-accessible port of the NextGen framework. In addition to enhancing research infrastructure, this project places a strong emphasis on fostering and promoting the integration of NextGen Framework within the broader research community.

With this development, and the accompanying training sessions, many researchers are now making much more rapid progress towards new developments in the NextGen framework and we expect this to lead quickly to improvements in the operational performance of upcoming versions of the Operational National Water Model.

It is a NextGen National Water Resources Modeling Framework Community Release

- Provides capabilities to run the Next Generation National Water Resources Modeling framework on your local machine for any size watershed.

![NGIAB](/img/ngiab.jpg)

Expand All @@ -18,18 +26,95 @@ NextGen National Water Resources Modeling Framework Community Release
- We want to have control over inputs / config.
- How can we do it? Answer: **NextGen In A Box**

## How to run the NextGen In A Box for your sample input data?

Follow the steps in README.md located at :
https://github.com/CIROH-UA/NGIAB-CloudInfra/blob/main/README.md

## How NGIAB CI pipeline works?

![NGIAB](/img/ngiab-ci.jpg)

## How NextGen In A Box is dependant on ngen and t-route?

![NGIAB](/img/ngiab-ngen-deps.jpg)

# Contribute to CIROH-UA/NGIAB-CloudInfra

### The summary steps to contribute to repo repository by forking it:

1. Fork the Repository:

- Visit the repository on GitHub.

- Click the "Fork" button in the top-right corner to create a copy of the repository in your - GitHub account.

2. Clone Your Fork:

- Go to your forked repository on GitHub.

- Click the "Code" button and copy the repository URL.

- Use git clone to clone your fork to your local machine:

```bash

git clone <your-fork-url>

```

3. Create a New Branch:

- Create a new branch for your changes using git checkout -b < branch-name>.

4. Make Changes:

- Open project files in your code editor and make the necessary changes.

5. Commit Changes:

- Use git add . to stage changes.

- Commit your changes with git commit -m "Your commit message".

6. Push Changes to Your Fork:

- Push your local branch to your fork on GitHub with git push origin < branch-name>.

7. Create a Pull Request (PR):

- Go to your forked repository on GitHub.

- Click "Compare & pull request" to create a PR.

- Provide a title and description for your PR.

- Click "Create pull request."

8. Review and Collaborate:

- Engage in discussions with maintainers and address feedback.

- Once approved, the PR can be merged into the original repository.

9. Sync Your Fork (Optional):

- If changes have been made to the original repository, you can sync your fork by adding the original repository as a remote and pulling changes from it.

## Technologies

- Git
- Github
- Github Actions - Using Github Actions for Continous Integration and Continous Deployment (CI/CD)
- Docker - Using docker to create, deploy and run NextGen application in containers.
- Docker - Employing Docker to build, deploy, and run NextGen applications within containers.
- DockerHub - Utilizing DockerHub for container image management.
- AWS S3 - Storing input data in AWS S3 buckets.

## Code

The source code for the NextGen In A Box can be found on Github:

- Github URL: [CIROH-UA/CloudInfra](https://github.com/CIROH-UA/CloudInfra)
- Github URL: [CIROH-UA/NGIAB-CloudInfra](https://github.com/CIROH-UA/NGIAB-CloudInfra)

Docker images are available at:

Expand All @@ -47,6 +132,10 @@ For more information, please refer the latest slide below that is used for train

- [NextGen In A Box - May 2023](https://github.com/CIROH-UA/Conferences/tree/main/CIROHdevCon23)

### Poster from CIROH Science Meeting - October 2023



## Bug and Issue Tracker

Please report bugs and issues on the Github Issues page:
Expand Down
Binary file added static/img/ngiab-ci.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/ngiab-ngen-deps.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/ngiablogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3be5f86

Please sign in to comment.