Update on readme.md file (Documentation) #704
Conversation
AminTorabi-NOAA
requested review from
kumdonoaa,
shorvath-noaa and
JurgenZach-NOAA
readme.md
Outdated
| @@ -59,13 +97,50 @@ $ cd test/LowerColorado_TX | |||
| $ python3 -m nwm_routing -V3 -f test_AnA.yaml | |||
There was a problem hiding this comment.
I think we can include two main test cases one for NHD and the other for HYfeature. So, for example, -V4 -f test_AnA_V4_NHD.yaml and -V -f test_AnA_V4_HYFeature.yaml as V4 is the most update main function.
There was a problem hiding this comment.
Good point. I'll update that
readme.md
Outdated
| @@ -2,16 +2,51 @@ | |||
|
|
|||
| **Fast, flexible, modular channel routing for the National water model and beyond**: | |||
|
|
|||
| t-route solves 1-D channel routing problems for vector-based river network data, such as USGS's NHDPlus High Resolution dataset. Provided a series lateral inflows for each node in a channel network, t-route computes the resulting streamflows. t-route requires that all routing computations srictly obey an upstream-to-downstream ordering. Such ordering facilitates the heterogenous application of routing models in a single river network. For example, hydrologic models - such as Muskingum Cunge - may be more appropriate for low-order headwater streams where backwater conditions are less likely to affect regional flooding. On the other hand, more computationally intensive hydraulic models - such as the diffusive wave approximation of St. Venant equations - are better suited for high-order streams and rivers where backwater flooding regularly impacts regional communities. With t-route, users are free to create routing models that use hydraulic solutions (and their computational resources) only where they are most needed, while relying on simpler hydrologic solutions elsewhere. | |||
| T-route, a dynamic channel routing model, offers a comprehensive solution for river network routing problems. It is designed to handle 1-D channel routing challenges in vector-based river network data, such as the USGS's NHDPlus High Resolution dataset, and OGC WaterML 2.0 Surface Hydrology Features (HY_Features) data model used in NWMv3.0. | |||
There was a problem hiding this comment.
Is HYFeatures used for NWMv3.0? I don't think it is. Do you mean NextGen framework?
There was a problem hiding this comment.
Yes NextGen. I'll change that
readme.md
Outdated
|
|
||
| t-route development is rigorously aligned with and guided by the NOAA Office of Water Prediction mission: *Collaboratively research, develop and deliver timely and consistent, state-of-the-science national hydrologic analyses, forecast information, data, guidance and equitable decision-support services to inform essential emergency management and water resources decisions across all time scales.* | ||
| Expanding its capabilities, t-route now supports the OGC WaterML 2.0 Surface Hydrology Features (HY_Features) data model, facilitating the management of complex acyclic network connectivity. This extends t-route's applicability to simulating reservoirs, assimilating reservoir release data, streamflow nudging, and provides users with a choice of routing solutions, including Muskingum-Cunge, Diffusive Wave, or Dynamic Wave. |
There was a problem hiding this comment.
This reads like reservoir routing and DA are a result of applying t-route on the HYFeatures network, which is not true. Those features exist for the NHDNetwork as well.
There was a problem hiding this comment.
Same goes for heterogeneous routing modules.
There was a problem hiding this comment.
Is this better?
"Expanding its capabilities, t-route now supports the OGC WaterML 2.0 Surface Hydrology Features (HY_Features) data model, facilitating the management of complex acyclic network connectivity. HY_Features data model provides users with a choice of routing solutions, including Muskingum-Cunge, Diffusive Wave, or Dynamic Wave."
This is just a first draft of an update on readme file for documentation.
Additions
1- A folder name
imagesunder thedocis added to include all the images that will be use in readme.md file2- Structure of folders added
3- Installation requirement for windows user (on WSL) is added. @JurgenZach-NOAA if you have any additional comments on installation and possible issues on WSL please feel free to add
Removals
Changes
Testing
Screenshots
Notes
Todos
Checklist
Testing checklist
Target Environment support
Accessibility
Other