-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from arashmodrad/main
Expanded on readme
- Loading branch information
Showing
19 changed files
with
495 additions
and
208 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,15 +3,15 @@ output: github_document | |
| --- | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
|
||
| ```{r, include = FALSE} | ||
| options(width=100) | ||
| knitr::opts_chunk$set( | ||
| collapse = TRUE, | ||
| comment = "#>", | ||
| fig.path = "man/figures/README-", | ||
| fig.path = 'man/figures/' | ||
| out.width = "100%", | ||
| warning = FALSE, | ||
| message = FALSE | ||
| #warning = FALSE, | ||
| message = TRUE | ||
| ) | ||
| ``` | ||
|
|
||
|
|
@@ -21,9 +21,19 @@ knitr::opts_chunk$set( | |
| [](https://github.com/mikejohnson51/hydrofabric3D/actions/workflows/R-CMD-check.yaml) | ||
| <!-- badges: end --> | ||
|
|
||
| - [Repo](#Repository) | ||
| * [Installation](#Installation) | ||
| - [Overview](#Overview) | ||
| - [Data Model](#Data-Model) | ||
| - [Cross Sections](#Cross-Section ) | ||
| - [Getting involved](#Getting-involved) | ||
| - [Open source licensing info](#Open-source-licensing-info) | ||
|
|
||
| ## Repository | ||
|
|
||
| The goal of hydrofabric3D is to generate DEM-based cross sections for hydrographic networks. | ||
|
|
||
| ## Installation | ||
| ### Installation | ||
|
|
||
| You can install the development version of hydrofabric3D from [GitHub](https://github.com/) with: | ||
|
|
||
|
|
@@ -32,7 +42,76 @@ You can install the development version of hydrofabric3D from [GitHub](https://g | |
| devtools::install_github("mikejohnson51/hydrofabric3D") | ||
| ``` | ||
|
|
||
| ## ... | ||
| ## Overview | ||
|
|
||
| This project develops a high resolution river channel/corridor data product based of [Reference Hydrofabric](https://noaa-owp.github.io/hydrofabric/articles/02-design-deep-dive.html) that support the modeling needs of NOAA and USGS. It is comprised of multiple modules that together form a clear picture of hydrofabric3D data model. This includes: | ||
|
|
||
| * Development of an automated tools to generate cross sections from a DEM | ||
| * Develop machine learning algorithms to predict river channel depth, width, and shape using ground observation 3. | ||
| * Estimate channel width using multi-source data and methods (e.g., remote sensing) | ||
|
|
||
| Schematic representation of the data model structure and how it is integrated into different products is shown bellow. | ||
|
|
||
|  | ||
|
|
||
| This data model data is provided through an R package that cuts cross-sections along rivers using 10m DEM and is informed with satellite, other products, and machine learning estimates of channel geometry (see [channel-shape-ML repo](https://github.com/NOAA-OWP/3d-hydrofabric/)). | ||
|
|
||
| ## Data Model | ||
|
|
||
| The structure of the data model is based on the reference Hydrofabric Data Model and | ||
|
|
||
| * Has the ability to represent a cross section transect and elevation | ||
| * Index knows and synthetic cross sections to a reference network | ||
| * Can be supplemented by HEC RAS, eHydro, Lidar | ||
|
|
||
|  | ||
|
|
||
| visit this [website](https://noaa-owp.github.io/hydrofabric/articles/cs_dm.html) for more updates. | ||
|
|
||
| ## Cross Section | ||
|
|
||
| The cross-section tool purpose is to generate DEM-based cross-sections (flood plains) for hydrographic networks and contains the estimates of bankfull channel cross section geometry and wherever there is HEC-RAS or Lidar data it incorporates them as well. | ||
|
|
||
| An example of how these cross-sections look is shown below and a full description is available at [terrain_sliceR](https://github.com/mikejohnson51/terrain_sliceR) | ||
|
|
||
| <div style="display: flex; justify-content: center;"> | ||
| <img src="man/figures/cross-sec1.png" width="50%"> | ||
| </div> | ||
|
|
||
| OWP requires cross sections across the complete CONUS network to support hydrologic modeling and requisite flood mapping. We have automated this process and dealt with issues such as braided systems. | ||
|
|
||
|  | ||
|
|
||
| Then we define and classify the cross section into left, right banks and in-channel as shown below. The problem is the flat line on the bottom of these plots, which represents the water level when this data was collected and nothing about the conditions at the time of collection (flood, dry year, etc.) | ||
|
|
||
| <div style="display: flex; justify-content: center;"> | ||
| <img src="man/figures/cs3.png" width="50%"> | ||
| </div> | ||
| . | ||
|
|
||
| More details about the proposed data model that follows Hyfeatures referencing and how tabular and spatial data are represented can be found [here](https://noaa-owp.github.io/hydrofabric/articles/cs_dm.html) | ||
|
|
||
| ## Getting involved | ||
|
|
||
| NOAA's National Water Center welcomes anyone to contribute to the Hydrofabric3D repository to enhance OWP's FIM and NextGen capabilities. List of contact information is outlined below: | ||
|
|
||
| J. Michael Johnson ([email protected]) for questions regarding hydrofabrics. | ||
|
|
||
| Dami Eyelade ([email protected]) for questions regarding satellite derived products. | ||
|
|
||
| Angus Watters ([email protected]) for questions regarding cross sections. | ||
|
|
||
| Arash Modaresi Rad ([email protected]) for questions regarding machine learning models. | ||
|
|
||
|
|
||
| ---- | ||
|
|
||
| ## Open source licensing info | ||
| 1. [TERMS](TERMS.md) | ||
| 2. [LICENSE](LICENSE) | ||
|
|
||
| ---- | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,152 @@ | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
|
||
| # hydrofabric3D | ||
|
|
||
| <!-- badges: start --> | ||
|
|
||
| [](https://github.com/mikejohnson51/hydrofabric3D/actions/workflows/R-CMD-check.yaml) | ||
| <!-- badges: end --> | ||
|
|
||
| The goal of hydrofabric3D is to generate DEM-based cross sections for | ||
| hydrographic networks. | ||
|
|
||
| ## Installation | ||
|
|
||
| You can install the development version of hydrofabric3D from | ||
| [GitHub](https://github.com/) with: | ||
|
|
||
| ``` r | ||
| # install.packages("devtools") | ||
| devtools::install_github("mikejohnson51/hydrofabric3D") | ||
| ``` | ||
|
|
||
| ## … | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
|
||
| # hydrofabric3D | ||
|
|
||
| <!-- badges: start --> | ||
|
|
||
| [](https://github.com/mikejohnson51/hydrofabric3D/actions/workflows/R-CMD-check.yaml) | ||
| <!-- badges: end --> | ||
|
|
||
| - [Repo](#Repository) | ||
| - [Installation](#Installation) | ||
| - [Overview](#Overview) | ||
| - [Data Model](#Data-Model) | ||
| - [Cross Sections](#Cross-Section) | ||
| - [Getting involved](#Getting-involved) | ||
| - [Open source licensing info](#Open-source-licensing-info) | ||
|
|
||
| ## Repository | ||
|
|
||
| The goal of hydrofabric3D is to generate DEM-based cross sections for | ||
| hydrographic networks. | ||
|
|
||
| ### Installation | ||
|
|
||
| You can install the development version of hydrofabric3D from | ||
| [GitHub](https://github.com/) with: | ||
|
|
||
| ``` r | ||
| # install.packages("devtools") | ||
| devtools::install_github("mikejohnson51/hydrofabric3D") | ||
| ``` | ||
|
|
||
| ## Overview | ||
|
|
||
| This project develops a high resolution river channel/corridor data | ||
| product based of [Reference | ||
| Hydrofabric](https://noaa-owp.github.io/hydrofabric/articles/02-design-deep-dive.html) | ||
| that support the modeling needs of NOAA and USGS. It is comprised of | ||
| multiple modules that together form a clear picture of hydrofabric3D | ||
| data model. This includes: | ||
|
|
||
| - Development of an automated tools to generate cross sections from a | ||
| DEM | ||
| - Develop machine learning algorithms to predict river channel depth, | ||
| width, and shape using ground observation 3. | ||
| - Estimate channel width using multi-source data and methods (e.g., | ||
| remote sensing) | ||
|
|
||
| Schematic representation of the data model structure and how it is | ||
| integrated into different products is shown bellow. | ||
|
|
||
| <figure> | ||
| <img src="assets/images/data_model.png" alt="DataModel1" /> | ||
| <figcaption aria-hidden="true">DataModel1</figcaption> | ||
| </figure> | ||
|
|
||
| This data model data is provided through an R package that cuts | ||
| cross-sections along rivers using 10m DEM and is informed with | ||
| satellite, other products, and machine learning estimates of channel | ||
| geometry (see [channel-shape-ML | ||
| repo](https://github.com/NOAA-OWP/3d-hydrofabric/)). | ||
|
|
||
| ## Data Model | ||
|
|
||
| The structure of the data model is based on the reference Hydrofabric | ||
| Data Model and | ||
|
|
||
| - Has the ability to represent a cross section transect and elevation | ||
| - Index knows and synthetic cross sections to a reference network | ||
| - Can be supplemented by HEC RAS, eHydro, Lidar | ||
|
|
||
| <figure> | ||
| <img src="assets/images/data_model2.png" alt="DataModel2" /> | ||
| <figcaption aria-hidden="true">DataModel2</figcaption> | ||
| </figure> | ||
|
|
||
| visit this | ||
| [website](https://noaa-owp.github.io/hydrofabric/articles/cs_dm.html) | ||
| for more updates. | ||
|
|
||
| ## Cross Section | ||
|
|
||
| The cross-section tool purpose is to generate DEM-based cross-sections | ||
| (flood plains) for hydrographic networks and contains the estimates of | ||
| bankfull channel cross section geometry and wherever there is HEC-RAS or | ||
| Lidar data it incorporates them as well. | ||
|
|
||
| An example of how these cross-sections look is shown below and a full | ||
| description is available at | ||
| [terrain_sliceR](https://github.com/mikejohnson51/terrain_sliceR) | ||
|
|
||
| <div style="display: flex; justify-content: center;"> | ||
|
|
||
| <img src="assets/images/cross-sec1.png" width="50%"> | ||
|
|
||
| </div> | ||
|
|
||
| OWP requires cross sections across the complete CONUS network to support | ||
| hydrologic modeling and requisite flood mapping. We have automated this | ||
| process and dealt with issues such as braided systems. | ||
|
|
||
| <figure> | ||
| <img src="assets/images/cs2.png" alt="cs2" /> | ||
| <figcaption aria-hidden="true">cs2</figcaption> | ||
| </figure> | ||
|
|
||
| Then we define and classify the cross section into left, right banks and | ||
| in-channel as shown below. The problem is the flat line on the bottom of | ||
| these plots, which represents the water level when this data was | ||
| collected and nothing about the conditions at the time of collection | ||
| (flood, dry year, etc.) | ||
|
|
||
| <div style="display: flex; justify-content: center;"> | ||
|
|
||
| <img src="assets/images/cs3.png" width="50%"> | ||
|
|
||
| </div> | ||
|
|
||
| . | ||
|
|
||
| More details about the proposed data model that follows Hyfeatures | ||
| referencing and how tabular and spatial data are represented can be | ||
| found [here](https://noaa-owp.github.io/hydrofabric/articles/cs_dm.html) | ||
|
|
||
| ## Getting involved | ||
|
|
||
| NOAA’s National Water Center welcomes anyone to contribute to the | ||
| Hydrofabric3D repository to enhance OWP’s FIM and NextGen capabilities. | ||
| List of contact information is outlined below: | ||
|
|
||
| J. Michael Johnson (<[email protected]>) for questions regarding | ||
| hydrofabrics. | ||
|
|
||
| Dami Eyelade (<[email protected]>) for questions regarding satellite | ||
| derived products. | ||
|
|
||
| Angus Watters (<[email protected]>) for questions regarding cross | ||
| sections. | ||
|
|
||
| Arash Modaresi Rad (<[email protected]>) for questions regarding | ||
| machine learning models. | ||
|
|
||
| ------------------------------------------------------------------------ | ||
|
|
||
| ## Open source licensing info | ||
|
|
||
| 1. [TERMS](TERMS.md) | ||
| 2. [LICENSE](LICENSE) | ||
|
|
||
| ------------------------------------------------------------------------ |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.