diff --git a/docs/Protocols/index.md b/docs/Documentation/Protocols/index.md similarity index 100% rename from docs/Protocols/index.md rename to docs/Documentation/Protocols/index.md diff --git a/docs/Documentation/running/index.md b/docs/Documentation/running/index.md new file mode 100644 index 0000000..aea6077 --- /dev/null +++ b/docs/Documentation/running/index.md @@ -0,0 +1,17 @@ +--- +title: Running the RIM Tool +weight: 1 +--- + +These steps take you through the necessary steps to run the RIM tool. The methods themselves are elaborated in [Bartelt et al. 2021](https://digitalcommons.usu.edu/etd/8226/). + +- [Step 1: Gather Inputs]({{ site.baseurl }}/Documentation/tool_users/3-Step3.html) +- [Step 2: Project Builder]({{ site.baseurl }}/Documentation/tool_users/2-Step2_createproject) +- [Step 3: Mapping]({{ site.baseurl }}/Documentation/tool_users/3-Step3) + - [Step 3a: Mappings]({{ site.baseurl }}/Documentation/tool_users/3a) + - [Step 3b: Create New DCE]({{ site.baseurl }}/Documentation/tool_users/3b) +- [Step 4: Calculate Metrics]({{ site.baseurl }}/Documentation/tool_users/4-Step4_calcMetrics) + +
+ +
diff --git a/docs/Documentation/tool_users/1-Step1_inputs.md b/docs/Documentation/running/step1.md similarity index 78% rename from docs/Documentation/tool_users/1-Step1_inputs.md rename to docs/Documentation/running/step1.md index e52100f..df1b204 100644 --- a/docs/Documentation/tool_users/1-Step1_inputs.md +++ b/docs/Documentation/running/step1.md @@ -1,21 +1,27 @@ ---- -title: Step 1 - Gather Inputs -weight: 1 ---- -The first step to mapping your riverscape and running the tool is to gather the required input files. - -## Inputs - -The required inputs to use the Riverscape Inundation Mapper tool in full are: -- imagery -- Digital Elevation Model (DEM) - -### Imagery -Potential sources of imagery include Unmanned Aerial Vehicle (UAV) orthomosaics, imagery from the National Agriculture Imagery Program (NAIP), Google Earth, Light Detection and Ranging (LIDAR) data, and more. -### DEM -We typically use [USGS National Elevation Dataset (NED)](https://viewer.nationalmap.gov/basic/) 1/3 arc second (~ 10 m) DEM data. - -The following ptional inputs are useful and provide additional context for valley bottom mapping and information about the local hydrology: -- [VBET](http://rcat.riverscapes.net/Documentation/Version_1.0/VBET.html#toc-valley-bottom-extraction-tool-vbet-) output -- [BRAT](https://brat.riverscapes.net/) output -- hillshade \ No newline at end of file +--- +title: Step 1 Gather Inputs +weight: 1 +--- + +The first step to mapping your riverscape and running the tool is to gather the required input files. + +## Inputs + +The required inputs to use the Riverscape Inundation Mapper tool in full are: + +- imagery +- Digital Elevation Model (DEM) + +### Imagery + +Potential sources of imagery include Unmanned Aerial Vehicle (UAV) orthomosaics, imagery from the National Agriculture Imagery Program (NAIP), Google Earth, Light Detection and Ranging (LIDAR) data, and more. + +### DEM + +We typically use [USGS National Elevation Dataset (NED)](https://viewer.nationalmap.gov/basic/) 1/3 arc second (~ 10 m) DEM data. + +The following optional inputs are useful and provide additional context for valley bottom mapping and information about the local hydrology: + +- [VBET](http://rcat.riverscapes.net/Documentation/Version_1.0/VBET.html#toc-valley-bottom-extraction-tool-vbet-) output +- [BRAT](https://brat.riverscapes.net/) output +- hillshade diff --git a/docs/Documentation/tool_users/2-Step2_createproject.md b/docs/Documentation/running/step2.md similarity index 94% rename from docs/Documentation/tool_users/2-Step2_createproject.md rename to docs/Documentation/running/step2.md index d255663..4436bda 100644 --- a/docs/Documentation/tool_users/2-Step2_createproject.md +++ b/docs/Documentation/running/step2.md @@ -1,25 +1,23 @@ ---- -title: Step 2 - Project Builder -weight: 2 ---- - -## Project Builder - -The next step is to run the [Project Builder script](https://github.com/Riverscapes/inundation/blob/master/Step2_ProjectBuilder.py). This script is designed to take the inputs and organize them into a consistent project folder structure. This script will create empty shapefiles to map context features and your first Data Capture Event (DCE) - -## Inputs -### Files -- **project_path** - The path to a folder where you want the project folder structure to be created -- **srs_template** - The path to a shapefile that contains the desired coordinate system and projection for your project shapefiles -- **image_path** - The path to an image raster of the site -- **DEM_path** - The path to the input DEM -- **hs_path** - The path to a hillshade -- **BRAT_path** - The path to a BRAT output shapefile -- **VBET_path** - The path to a VBET output shapefile - -### Parameters -#### Site or project parameters -- **site_name** The name of the project -- **huc** - the 8 digit Hydrologic Unit Code - - +--- +title: Step 2 Project Builder +weight: 2 +--- + +## Project Builder + +The next step is to run the [Project Builder script](https://github.com/Riverscapes/inundation/blob/master/Step2_ProjectBuilder.py). This script is designed to take the inputs and organize them into a consistent project folder structure. This script will create empty shapefiles to map context features and your first Data Capture Event (DCE) + +## Inputs +### Files +- **project_path** - The path to a folder where you want the project folder structure to be created +- **srs_template** - The path to a shapefile that contains the desired coordinate system and projection for your project shapefiles +- **image_path** - The path to an image raster of the site +- **DEM_path** - The path to the input DEM +- **hs_path** - The path to a hillshade +- **BRAT_path** - The path to a BRAT output shapefile +- **VBET_path** - The path to a VBET output shapefile + +### Parameters +#### Site or project parameters +- **site_name** The name of the project +- **huc** - the 8 digit Hydrologic Unit Code diff --git a/docs/Documentation/tool_users/3-Step3_Mapping/index.md b/docs/Documentation/running/step3.md similarity index 57% rename from docs/Documentation/tool_users/3-Step3_Mapping/index.md rename to docs/Documentation/running/step3.md index 4cd3cd9..9af86b6 100644 --- a/docs/Documentation/tool_users/3-Step3_Mapping/index.md +++ b/docs/Documentation/running/step3.md @@ -1,32 +1,32 @@ ---- -title: Step 3 - Mapping -weight: 3 ---- - -## Map Features - -There are 2 types of features that you will map -- Context features -- Data Capture Events (DCEs) - -### Context features -The context features you need to map are the valley bottom and a valley bottom centerline. These features are typically consistent over time. - -Empty shapefiles were created for the context features when you ran the Project Builder script in [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) and are located in the **02_Mapping/RS_01 folder** of your project folder. - -Because the context features will typically not change over time, you will likely only need or want to map them once. However, additional versions of these features could be mapped and saved within the 02_Mapping folder in a new folder called RS_02, RS_03, etc. - -### DCEs -The Data Capture Event features to map are the structure or beaver dam crests, thalwegs, and the inundated area and type. These features represent a snapshot of your project area in time and should be mapped seperately for each different image or time of interest. - -##### DCE 1 -All features that need to be mapped for the first DCE were created when you ran the Project Builder script in [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) and are located in the **02_Mapping/DCE_01 folder** of your project folder. - -##### Subsequent DCEs -For additional DCEs you can provide a new image and create new blank DCE shapefiles using the Create_DCE script in [Step 3b](http://rim.riverscapes.net/Documentation/tool_users/3-Step3_Mapping/2-Step3b_newDCE.html). - -Reasons for which you might want to create a 2nd, 3rd, etc DCE: -- to map changes in inundation at different flows -- to track changes in inundation over time -- using imagery from the same date but from a different source (e.g. to make a comparison between UAV acquired imagery and NAIP imagery) -- to compare outputs from two different mappers \ No newline at end of file +--- +title: Step 3 Map Features +weight: 3 +--- + +## Map Features + +There are 2 types of features that you will map +- [Context features]({{ site.baseurl }}/Documentation/running/step3a.html) - Step 3a +- [Data Capture Events]({{ site.baseurl }}/Documentation/running/step3b.html) (DCEs) - Step 3b + +### Context features +The context features you need to map are the valley bottom and a valley bottom centerline. These features are typically consistent over time. + +Empty shapefiles were created for the context features when you ran the Project Builder script in [Step 2]({{ site.baseurl }}/Documentation/running/step2.html) and are located in the **02_Mapping/RS_01 folder** of your project folder. + +Because the context features will typically not change over time, you will likely only need or want to map them once. However, additional versions of these features could be mapped and saved within the 02_Mapping folder in a new folder called RS_02, RS_03, etc. + +### DCEs +The Data Capture Event features to map are the structure or beaver dam crests, thalwegs, and the inundated area and type. These features represent a snapshot of your project area in time and should be mapped separately for each different image or time of interest. + +##### DCE 1 +All features that need to be mapped for the first DCE were created when you ran the Project Builder script in [Step 2]({{ site.baseurl }}/Documentation/running/step2.html) and are located in the **02_Mapping/DCE_01 folder** of your project folder. + +##### Subsequent DCEs +For additional DCEs you can provide a new image and create new blank DCE shapefiles using the Create_DCE script in [Step 3b]({{ site.baseurl }}/Documentation/running/step3b.html). + +Reasons for which you might want to create a 2nd, 3rd, etc., DCE: +- to map changes in inundation at different flows +- to track changes in inundation over time +- using imagery from the same date but from a different source (e.g. to make a comparison between UAV acquired imagery and NAIP imagery) +- to compare outputs from two different mappers diff --git a/docs/Documentation/tool_users/3-Step3_Mapping/1-Step3a_Mapping.md b/docs/Documentation/running/step3a.md similarity index 98% rename from docs/Documentation/tool_users/3-Step3_Mapping/1-Step3a_Mapping.md rename to docs/Documentation/running/step3a.md index 6f625da..4acff57 100644 --- a/docs/Documentation/tool_users/3-Step3_Mapping/1-Step3a_Mapping.md +++ b/docs/Documentation/running/step3a.md @@ -1,75 +1,74 @@ ---- -title: Step 3a - Mapping -weight: 3 ---- - -## Context Features - -### Valley bottom -##### Background -[Wheaton et al., 2015](https://www.researchgate.net/publication/281321324_Geomorphic_Mapping_and_Taxonomy_of_Fluvial_Landforms) defined the valley bottom as the active channel(s) and contemporary floodplain. The spatial extent of the valley bottom represents the area that could plausibly flood during the contemporary flow regime. The margins or lateral extent of the valley bottom will be a confining margin, which are hillslope, fans, or terraces ([Wheaton et al., 2015](https://www.researchgate.net/publication/281321324_Geomorphic_Mapping_and_Taxonomy_of_Fluvial_Landforms)). - -![ValleyBottom]({{ site.baseurl }}/assets/images/oblique_valleyBottom-02.jpg) - -##### Mapping -During [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) an empty valley bottom shapefile was created in the **02_Mapping/RS_01 folder** of your project folder and is called **valley_bottom.shp** -###### Useful resources and lines of evidence for identifying the valley bottom extent -When mapping the valley bottom it is beneficial to use all available lines of evidence including observations made in the field, a DEM, aerial photos, google earth, contour maps, hillshades, etc. The upstream and downstream edge of your valley bottom polygon will determine the longitudinal extent of you project area. -### Valley bottom centerline -##### Mapping -During [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) an empty valley bottom centerline shapefile was created in the **02_Mapping/RS_01 folder** of your project folder and is called **vb_centerline.shp** - -The valley bottom centerline can be manually digitized or created using the ArcGIS [Polygon to Centerline Tool](https://www.arcgis.com/home/item.html?id=bc642731870740aabf48134f90aa6165) - -## DCE Features - -The Data Capture Event features to map are the structure or beaver dam crests, thalwegs, and the inundation types. These features are a snapshot in time and should be mapped seperately for each different image or time period of interest. - -### Dam or structure crests -During [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) an empty structures shapefile was created in the **02_Mapping/DCE_01 folder** of your project folder and is called **dam_crests.shp** - -For each beaver dam you will trace the crest of the beaver dam and will determine whether the dam is intact, breached, or blown out. You will then give each dam a unique dam ID and then determine the portion or length of the dam that is or is not actively structurally forcing flow at the time the image was taken. -#### Dam state -The dam state of each beaver dam is either intact, breached, or blown_out as defined below by [Hafen, 2017](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=7648&context=etd). - -- **intact** - a dam from which pond is fully maintained upstream of the dam -- **breached** - a dam where partial removal or loss of material from the dam crest results in a lowering of the pond water surface elevation -- **blown_out** - a dam where enough of the dam is breached or damaged such that the dam no longer backs up water - -The dam state for each dam should be entered in the dam_state attribute field of the shapefile as "intact", "breached", or "blown_out". - -#### Dam ID -Number each dam in the dam_id attribute field so that when you split the crest of each dam to describe the crest type the correct dam number is retained - -#### Crest type -For each dam crest, split the dam into the length of the crest that is or is not structurally forcing backwater upstream of the dam. To do this, use the split tool in the editor and populate the crest_type attribute field as either "active" or "inactive" - -- **active** - the portion of the dam that is actively backing up water upstream of the dam -- **inactive** - the portion of the dam that is not actively backing up water upstream of the dam - -### Thalwegs -To characterize more dynamic hydrogeomorphic attributes such as planform changes (e.g. multithreadedness and sinuosity) that potentially occur between survey dates we mapped the location and type of thalwegs in the riverscape at the time of each survey. We mapped 4 thalweg types adapted from the Kramer-Anderson et al. Geomorphic Unit Tool (GUT - http://gut.riverscapes.net); main, anabranch, split, and braid. -- **Main** – the thalweg that follows the deepest point of the primary anabranch -- **Anabranch** – thalwegs that follow the deepest point of a fully formed (i.e. has an active channel bed) secondary anabranch that is longer than 2 ocularly estimated bankfull channel widths -- **Split** – thalwegs that follow the deepest point of structurally forced sheetflow, or short secondary anabranches -- **Braid** – thalwegs within the primary anabranch that are not the main thalweg and are not structurally forced by large wood or beaver dams. These typically depart and return from the main thalweg or an anabranch thalweg. - - -#### Thalweg type -Attribute thalwegs to the following types: -- **Main** – the thalweg that follows the deepest point of the primary anabranch -- **Anabranch** – thalwegs that follow the deepest point of a fully formed (i.e. has an active channel bed) secondary anabranch that is longer than 2 ocularly estimated bankfull channel widths -- **Split** – thalwegs that follow the deepest point of structurally forced sheetflow, or short secondary anabranches -- **Braid** – thalwegs within the primary anabranch that are not the main thalweg and are not structurally forced by large wood or beaver dams. These typically depart and return from the main thalweg or an anabranch thalweg. -### Inundation -Be sure to map inundation at a consistent zoom level (we typically use 1:250). To map inundation simply digitize a polygon around the wetted edge visible in the aerial imagery. Where vegetation or shadows obscure the waters edge, infer the wetted extent between visible boundaries. If possible, predict vegetated areas that will be difficult to see the inundation and spot check at the time of imagery collection. -#### Inundation type - -Each inundation survey polygon was then broken into three flow type classes on a continuum from more lotic (free flowing) to more lentic (ponded, but still flowing). We defined these classes in Figure 5 as follows: -- **Free flowing** – not obstructed by a channel-spanning structural element -- **Overflow** – structurally-forced flow onto floodplain and/or otherwise expose in channel surfaces (e.g. bars) -- **Ponded** – structurally-forced backwater ponding upstream of a channel-spanning structural-element - - -![InundationType]({{ site.baseurl }}/assets/images/inun_types_tiny.png) - +--- +title: Step 3a Mapping +weight: 4 +--- + +## Context Features + +### Valley bottom +##### Background +[Wheaton et al., 2015](https://www.researchgate.net/publication/281321324_Geomorphic_Mapping_and_Taxonomy_of_Fluvial_Landforms) defined the valley bottom as the active channel(s) and contemporary floodplain. The spatial extent of the valley bottom represents the area that could plausibly flood during the contemporary flow regime. The margins or lateral extent of the valley bottom will be a confining margin, which are hillslope, fans, or terraces ([Wheaton et al., 2015](https://www.researchgate.net/publication/281321324_Geomorphic_Mapping_and_Taxonomy_of_Fluvial_Landforms)). + +![ValleyBottom]({{ site.baseurl }}/assets/images/oblique_valleyBottom-02.jpg) + +##### Mapping +During [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) an empty valley bottom shapefile was created in the **02_Mapping/RS_01 folder** of your project folder and is called **valley_bottom.shp** +###### Useful resources and lines of evidence for identifying the valley bottom extent +When mapping the valley bottom it is beneficial to use all available lines of evidence including observations made in the field, a DEM, aerial photos, google earth, contour maps, hillshades, etc. The upstream and downstream edge of your valley bottom polygon will determine the longitudinal extent of you project area. +### Valley bottom centerline +##### Mapping +During [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) an empty valley bottom centerline shapefile was created in the **02_Mapping/RS_01 folder** of your project folder and is called **vb_centerline.shp** + +The valley bottom centerline can be manually digitized or created using the ArcGIS [Polygon to Centerline Tool](https://www.arcgis.com/home/item.html?id=bc642731870740aabf48134f90aa6165) + +## DCE Features + +The Data Capture Event features to map are the structure or beaver dam crests, thalwegs, and the inundation types. These features are a snapshot in time and should be mapped seperately for each different image or time period of interest. + +### Dam or structure crests +During [Step 2](http://rim.riverscapes.net/Documentation/tool_users/2-Step2_createproject.html) an empty structures shapefile was created in the **02_Mapping/DCE_01 folder** of your project folder and is called **dam_crests.shp** + +For each beaver dam you will trace the crest of the beaver dam and will determine whether the dam is intact, breached, or blown out. You will then give each dam a unique dam ID and then determine the portion or length of the dam that is or is not actively structurally forcing flow at the time the image was taken. +#### Dam state +The dam state of each beaver dam is either intact, breached, or blown_out as defined below by [Hafen, 2017](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=7648&context=etd). + +- **intact** - a dam from which pond is fully maintained upstream of the dam +- **breached** - a dam where partial removal or loss of material from the dam crest results in a lowering of the pond water surface elevation +- **blown_out** - a dam where enough of the dam is breached or damaged such that the dam no longer backs up water + +The dam state for each dam should be entered in the dam_state attribute field of the shapefile as "intact", "breached", or "blown_out". + +#### Dam ID +Number each dam in the dam_id attribute field so that when you split the crest of each dam to describe the crest type the correct dam number is retained + +#### Crest type +For each dam crest, split the dam into the length of the crest that is or is not structurally forcing backwater upstream of the dam. To do this, use the split tool in the editor and populate the crest_type attribute field as either "active" or "inactive" + +- **active** - the portion of the dam that is actively backing up water upstream of the dam +- **inactive** - the portion of the dam that is not actively backing up water upstream of the dam + +### Thalwegs +To characterize more dynamic hydrogeomorphic attributes such as planform changes (e.g. multithreadedness and sinuosity) that potentially occur between survey dates we mapped the location and type of thalwegs in the riverscape at the time of each survey. We mapped 4 thalweg types adapted from the Kramer-Anderson et al. Geomorphic Unit Tool (GUT - http://gut.riverscapes.net); main, anabranch, split, and braid. +- **Main** – the thalweg that follows the deepest point of the primary anabranch +- **Anabranch** – thalwegs that follow the deepest point of a fully formed (i.e. has an active channel bed) secondary anabranch that is longer than 2 ocularly estimated bankfull channel widths +- **Split** – thalwegs that follow the deepest point of structurally forced sheetflow, or short secondary anabranches +- **Braid** – thalwegs within the primary anabranch that are not the main thalweg and are not structurally forced by large wood or beaver dams. These typically depart and return from the main thalweg or an anabranch thalweg. + + +#### Thalweg type +Attribute thalwegs to the following types: +- **Main** – the thalweg that follows the deepest point of the primary anabranch +- **Anabranch** – thalwegs that follow the deepest point of a fully formed (i.e. has an active channel bed) secondary anabranch that is longer than 2 ocularly estimated bankfull channel widths +- **Split** – thalwegs that follow the deepest point of structurally forced sheetflow, or short secondary anabranches +- **Braid** – thalwegs within the primary anabranch that are not the main thalweg and are not structurally forced by large wood or beaver dams. These typically depart and return from the main thalweg or an anabranch thalweg. +### Inundation +Be sure to map inundation at a consistent zoom level (we typically use 1:250). To map inundation simply digitize a polygon around the wetted edge visible in the aerial imagery. Where vegetation or shadows obscure the waters edge, infer the wetted extent between visible boundaries. If possible, predict vegetated areas that will be difficult to see the inundation and spot check at the time of imagery collection. +#### Inundation type + +Each inundation survey polygon was then broken into three flow type classes on a continuum from more lotic (free flowing) to more lentic (ponded, but still flowing). We defined these classes in Figure 5 as follows: +- **Free flowing** – not obstructed by a channel-spanning structural element +- **Overflow** – structurally-forced flow onto floodplain and/or otherwise expose in channel surfaces (e.g. bars) +- **Ponded** – structurally-forced backwater ponding upstream of a channel-spanning structural-element + + +![InundationType]({{ site.baseurl }}/assets/images/inun_types_tiny.png) diff --git a/docs/Documentation/tool_users/3-Step3_Mapping/2-Step3b_newDCE.md b/docs/Documentation/running/step3b.md similarity index 70% rename from docs/Documentation/tool_users/3-Step3_Mapping/2-Step3b_newDCE.md rename to docs/Documentation/running/step3b.md index a5d405e..c8f75a9 100644 --- a/docs/Documentation/tool_users/3-Step3_Mapping/2-Step3b_newDCE.md +++ b/docs/Documentation/running/step3b.md @@ -1,23 +1,23 @@ ---- -title: Step 3b - Create New DCE -weight: 3 ---- - -## Create new DCE - -Run the ([Step3b_newDCE.py](https://github.com/Riverscapes/inundation/blob/master/STEP3b_newDCE.py)) script to create an additional data capture event. - -Examples for which you might want to create a 2nd, 3rd, etc DCE: -- to map a different snapshot in time at the same site (e.g. using imagery with a different date) -- using imagery from the same date but from a different source (e.g. to make a comparison between UAV acquired imagery and NAIP imagery) -- to compare outputs from two different mappers - -## Inputs -- **project_path** - The path to a folder where you want the project folder structure to be created -- **srs_template** - The path to a shapefile that contains the desired coordinate system and projection for your project shapefiles -- **AP_fold** - The name for the folder containing the new image. Use AP_02, AP_03, AP_04, etc. -- **image_path** - The path to an image raster -- **DCE_fold** - The name for the folder that will contain the new DCE shapefiles. Use DCE_01, DCE_02, DCE_03, etc. - -After you run this step return to [Step 3a](http://rim.riverscapes.net/Documentation/tool_users/3-Step3_Mapping/1-Step3a_Mapping.htmlhttp://rim.riverscapes.net/Documentation/tool_users/3-Step3_Mapping/1-Step3a_Mapping.html) to map the features in your 2nd DCE. While context features may occasionially change between DCEs, typically the only features you will re-map are the DCE features. - +--- +title: Step 3b Create New DCE +weight: 5 +--- + +## Create new DCE + +Run the ([Step3b_newDCE.py](https://github.com/Riverscapes/inundation/blob/master/STEP3b_newDCE.py)) script to create an additional data capture event. + +Examples for which you might want to create a 2nd, 3rd, etc DCE: +- to map a different snapshot in time at the same site (e.g. using imagery with a different date) +- using imagery from the same date but from a different source (e.g. to make a comparison between UAV acquired imagery and NAIP imagery) +- to compare outputs from two different mappers + +## Inputs +- **project_path** - The path to a folder where you want the project folder structure to be created +- **srs_template** - The path to a shapefile that contains the desired coordinate system and projection for your project shapefiles +- **AP_fold** - The name for the folder containing the new image. Use AP_02, AP_03, AP_04, etc. +- **image_path** - The path to an image raster +- **DCE_fold** - The name for the folder that will contain the new DCE shapefiles. Use DCE_01, DCE_02, DCE_03, etc. + +After you run this step return to [Step 3a]({{ site.baseurl }}/Documentation/running/step3a.html) to map the features in your 2nd DCE. While context features may occasionially change between DCEs, typically the only features you will re-map are the DCE features. + diff --git a/docs/Documentation/tool_users/4-Step4_calcMetrics.md b/docs/Documentation/running/step4.md similarity index 96% rename from docs/Documentation/tool_users/4-Step4_calcMetrics.md rename to docs/Documentation/running/step4.md index 2c5d522..1cdf08d 100644 --- a/docs/Documentation/tool_users/4-Step4_calcMetrics.md +++ b/docs/Documentation/running/step4.md @@ -1,41 +1,41 @@ ---- -title: Step 4 - Calculate Metrics -weight: 5 ---- - -## Calculate metrics - -Run [this script](https://github.com/Riverscapes/inundation/blob/master/STEP4_metricCalc.py) to calculate summary metrics from the features mapped in the DCEs - -### Inputs: -- **project_path** - The path to a folder where you want the project folder structure to be created -- **RS_folder_name** - The name of the folder with RS Context shapefiles you want to use to calculate site metrics (the folder with the Valley Bottom polygon) -- **DEM** - The path to the input DEM - -#### Site or project parameters -- **project_name** A readable name of the site -- **site_name** The shorthand name of the site -- **huc8** - the 8 digit Hydrologic Unit Code -- **setting** - the dominant beaver dam building opportunity present ("classic", "steep", or "floodplain") - -#### Metadata and parameters describing both DCEs that will be compared -- **DCE1_name** - the name of the first DCE folder you want to use for the metric calculation (e.g. "DCE_01") -- **DCE2_name** - the name of the second DCE folder you want to use for the metric calculation (e.g. "DCE_02") -##### DCE 1 parameters -- **DCE1_date** - the date that the imagery was acquired -- **DCE1_flow_stage** - the flow stage at the time of the imagery (e.g. low, moderate, high) -- **DCE1_active** - was there evidence of recent beaver activity at the site during the time of the imagery acquisition? -- **DCE1_maintained** - was there evidence of recent beaver dam maintenence at the site during the time of the imagery acquisition? -- **DCE1_res** - the resolution of the input imagery in meters -##### DCE 2 parameters -- **DCE2_date** - the date that the imagery was acquired -- **DCE2_flow_stage** - the flow stage at the time of the imagery (e.g. low, moderate, high) -- **DCE2_active** - was there evidence of recent beaver activity at the site during the time of the imagery acquisition? -- **DCE2_maintained** - was there evidence of recent beaver dam maintenence at the site during the time of the imagery acquisition? -- **DCE2_res** - the resolution of the input imagery in meters - -## Output Metrics -The following table includes all metric outputs - -![outputMetrics]({{ site.baseurl }}/assets/images/s1.png) - +--- +title: Step 4 Calculate Metrics +weight: 6 +--- + +## Calculate metrics + +Run [this script](https://github.com/Riverscapes/inundation/blob/master/STEP4_metricCalc.py) to calculate summary metrics from the features mapped in the DCEs + +### Inputs: +- **project_path** - The path to a folder where you want the project folder structure to be created +- **RS_folder_name** - The name of the folder with RS Context shapefiles you want to use to calculate site metrics (the folder with the Valley Bottom polygon) +- **DEM** - The path to the input DEM + +#### Site or project parameters +- **project_name** A readable name of the site +- **site_name** The shorthand name of the site +- **huc8** - the 8 digit Hydrologic Unit Code +- **setting** - the dominant beaver dam building opportunity present ("classic", "steep", or "floodplain") + +#### Metadata and parameters describing both DCEs that will be compared +- **DCE1_name** - the name of the first DCE folder you want to use for the metric calculation (e.g. "DCE_01") +- **DCE2_name** - the name of the second DCE folder you want to use for the metric calculation (e.g. "DCE_02") +##### DCE 1 parameters +- **DCE1_date** - the date that the imagery was acquired +- **DCE1_flow_stage** - the flow stage at the time of the imagery (e.g. low, moderate, high) +- **DCE1_active** - was there evidence of recent beaver activity at the site during the time of the imagery acquisition? +- **DCE1_maintained** - was there evidence of recent beaver dam maintenence at the site during the time of the imagery acquisition? +- **DCE1_res** - the resolution of the input imagery in meters +##### DCE 2 parameters +- **DCE2_date** - the date that the imagery was acquired +- **DCE2_flow_stage** - the flow stage at the time of the imagery (e.g. low, moderate, high) +- **DCE2_active** - was there evidence of recent beaver activity at the site during the time of the imagery acquisition? +- **DCE2_maintained** - was there evidence of recent beaver dam maintenence at the site during the time of the imagery acquisition? +- **DCE2_res** - the resolution of the input imagery in meters + +## Output Metrics +The following table includes all metric outputs + +![outputMetrics]({{ site.baseurl }}/assets/images/s1.png) + diff --git a/docs/Documentation/tool_users/index.md b/docs/Documentation/tool_users/index.md deleted file mode 100644 index b4a2859..0000000 --- a/docs/Documentation/tool_users/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Running the RIM Tool -weight: 1 ---- - -These steps take you through the necessary steps to run the RIM tool. \ No newline at end of file