Updating documentation

Riverscapes · May 14, 2020 · 26a63f6 · 26a63f6
1 parent 970af68
commit 26a63f6
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 9 deletions.
diff --git a/docs/Documentation/RCAT.md b/docs/Documentation/RCAT.md
@@ -26,6 +26,7 @@ For documentation on the major changes implemented, see [RCAT Version 2.0]({{ si
 - [Bankfull Channel]({{ site.baseurl }}/Documentation/Version_2.0/RCAT/4-BankfullChannelTool)
 - [Confinement Tool]({{ site.baseurl }}/Documentation/Version_2.0/RCAT/5-ConfinementTool)
 - [Riparian Condition Assessment]({{ site.baseurl }}/Documentation/Version_2.0/RCAT/6-RCA)
+- [Layer Package Generator]({{ site.baseurl }}/Documentation/Version_2.0/RCAT/7-LayerPackageGenerator)
 
 **VBET** (Valley Bottom Extraction Toolbox)
 - [VBET Project Builder]({{ site.baseurl }}/Documentation/Version_2.0/VBET/1-VBETProjectBuilder)
@@ -55,6 +56,10 @@ For documentation on the major changes implemented, see [RCAT Version 2.0]({{ si
 
 ### Update History
 
+**05/14/2020 - RCAT Version 2.0.2** - Added Layer Package Generator Tool and fixed bugs.
+
+**04/17/2020 - RCAT Version 2.0.1** - Fixed bug in RCA tool.
+
 **04/11/2020 - RCAT Version 2.0.0** - Added bankfull channel and confinement tools for more accurate confinement metrics, added flexibility in vegetation input, added flexibility for vegetation classifications, added dredge tailings handling, added separate native riparian vegetation departure and overall riparian departure fields, improved riparian conversion metrics, added riparian conversion fields for riparian expansion and conversion to deciduous forest, increased linearity between RCAT tools, improved RCAT project folder structure, improved valley bottom delineation, added batch scripts for VBET, improved toolbox structure, added supporting tools for classifying LANDFIRE vegetation and segmenting the network, and increased stability of tools by fixing many minor bugs. Details on these changes can be found on the [RCAT Version 2.0 page]({{ site.baseurl }}/Documentation/Version_2.0/). 
 
 **09/12/2017 - RCAT Versions 1.0.11 and 0.2.3** - fixed same bug that RVD tool had (fixed 1.0.9) in RCA tool.

diff --git a/docs/Documentation/Version_2.0/RCAT/1-Preprocessing.md b/docs/Documentation/Version_2.0/RCAT/1-Preprocessing.md
@@ -1,5 +1,5 @@
 ---
-title: Pre-Processing RCAT Inputs
+title: Step 1: Pre-Processing RCAT Inputs
 category: RCAT
 ---
 

diff --git a/docs/Documentation/Version_2.0/RCAT/2-RCATProjectBuilder.md b/docs/Documentation/Version_2.0/RCAT/2-RCATProjectBuilder.md
@@ -1,5 +1,5 @@
 ---
-title: Step 1 - RCAT Project Builder
+title: Step 2 - RCAT Project Builder
 category: RCAT
 ---
 

diff --git a/docs/Documentation/Version_2.0/RCAT/3-RVD.md b/docs/Documentation/Version_2.0/RCAT/3-RVD.md
@@ -1,5 +1,5 @@
 ---
-title: Step 2 - Riparian Vegetation Departure (RVD)
+title: Step 3 - Riparian Vegetation Departure (RVD)
 category: RCAT
 ---
 
@@ -32,7 +32,7 @@ The Riparian Vegetation Departure (RVD) tool uses vegetation landcover inputs to
 - **Riparian Vegetation Departure ratio** `RIPAR_DEP`: This is calculated for each reach by finding the area of current existing riparian landcover (including nonnative species) within valley bottom of a reach, then dividing this value by the historic riparian landcover within the reach's valley bottom.
 
 ![RVD_Riparian_Departure]({{ site.baseurl }}/assets/images/RVD_RiparDep.png)
- 
+
 - **Riparian Vegetation Conversion Type** `CONV_TYPE`: This is identified by comparing landcover within the riparian zone, with the riparian zone defined as the area within the valley bottom that is classified as riparian in either the existing *or* historic vegetation rasters. 
 
 ![RVD_Conv_Type]({{ site.baseurl }}/assets/images/RVD_Conversion.png)

diff --git a/docs/Documentation/Version_2.0/RCAT/4-BankfullChannelTool.md b/docs/Documentation/Version_2.0/RCAT/4-BankfullChannelTool.md
@@ -1,5 +1,5 @@
 ---
-title: Step 3 - Bankfull Channel Polygon Tool
+title: Step 4 - Bankfull Channel Polygon Tool
 category: RCAT
 ---
 

diff --git a/docs/Documentation/Version_2.0/RCAT/5-ConfinementTool.md b/docs/Documentation/Version_2.0/RCAT/5-ConfinementTool.md
@@ -1,5 +1,5 @@
 ---
-title: Step 4 - Confinement Tool
+title: Step 5 - Confinement Tool
 category: RCAT
 ---
 
@@ -34,7 +34,6 @@ Output stream network including the above attribute fields, symbolized by the co
 
 ![Confinement_output]({{ site.baseurl }}/assets/images/ConfinementOutput_2.0.PNG)
 
-
 ------------------------------------------------------------------------------------------------------------------------------
 ## Confinement Tool Workflow
 
@@ -47,7 +46,6 @@ Output stream network including the above attribute fields, symbolized by the co
 7. The average width of the valley bottom polygon `VAL_Width` corresponding to each stream segment is calculated by dividing the polygon area `VAL_Area` by the segment length `Rch_Len`. This value essentially is the width of the valley bottom polygon converted to a rectangle of equal area.
 8. The confinement index `CONFIN_RATIO` is calculated by dividing the bankfull channel width `BFC_Width` by the valley bottom width `VAL_Width`.
 
-
 --------------------------------
 <div align="center">
 	<a class="hollow button" href="{{ site.baseurl }}/Documentation/Version_2.0/RCAT/4-BankfullChannelTool"><i class="fa fa-arrow-circle-left"></i> Back to Step 4 </a>

diff --git a/docs/Documentation/Version_2.0/RCAT/6-RCA.md b/docs/Documentation/Version_2.0/RCAT/6-RCA.md
@@ -1,5 +1,5 @@
 ---
-title: Step 5 - Riparian Condition Assessment (RCA)
+title: Step 6 - Riparian Condition Assessment (RCA)
 category: RCAT
 ---
 
@@ -53,4 +53,5 @@ Conceptual diagram showing how riparian condition assessment is calculated
 --------------------------------
 <div align="center">
 	<a class="hollow button" href="{{ site.baseurl }}/Documentation/Version_2.0/RCAT/5-ConfinementTool"><i class="fa fa-arrow-circle-left"></i> Back to Step 5 </a>
+	<a class="hollow button" href="{{ site.baseurl }}/Documentation/Version_2.0/RCAT/7-LayerPackageGenerator"><i class="fa fa-arrow-circle-right"></i> Continue to Step 7 </a>
 </div>	
diff --git a/docs/Documentation/Version_2.0/RCAT/7-LayerPackageGenerator.md b/docs/Documentation/Version_2.0/RCAT/7-LayerPackageGenerator.md
@@ -0,0 +1,41 @@
+---
+title: Step 7 - Layer Package Generator
+category: RCAT
+---
+
+The Layer Package Generator tool is an optional final step in the RCAT toolbox. Each of the RCAT tools creates layer files for relevant inputs, intermediates, and outputs, which allow the user to review and investigate the model results. Layer files are difficult to share or transfer because the rely on an absolute file path to a data source, which breaks when the layer is moved from its original location. Layer packages resolve this issue by including the data source with the layer. 
+
+The Layer Package Generator gathers and organizes all layers from the RCAT model (and generates new layers if not found) into a layer package for easy transfer of model results.
+
+## Running the Layer Package Generator
+Completing the following steps before running the Layer Package Generator tool will ensure that the tool runs as desired.
+
+**Clean up the project folder**
+The Layer Package Generator relies on a consistent folder structure to find layer files and source data. As of the latest release (RCAT V2.0.2) the tool is not able to accept multiple versions of any input or output. Examples of this include: 
+
+- Multiple networks, existing/historic vegetation rasters, valley bottoms, etc.
+- Multiple iterations of RVD, Bankfull, Confinement, or RCA.
+
+Before running the Layer Package Generator, you must select one version to include in the layer package and temporarily remove all other folders and files from the project folder. 
+
+**Clear the table of contents**
+Remove all files from the table of contents before running the tool. The tool may throw an error if the table of contents is not clear. 
+
+### Inputs
+
+![LPG_interface]({{ site.baseurl }}/assets/images/LPG_interface_2.0.PNG)
+
+- **Output Folder** : RCAT automatically creates output folders, labeled “Output_01”, “Output_02”, etc. Layer Packages are meant to contain the outputs of only one run of RCAT. Choose which set of outputs you want to base your layer package off.
+- **Layer Package Name** : Any set of characters is acceptable as input for the layer package name. If you choose to not give the tool a name for the layer package, it will default to “RCATLayerPackage.lpk” or "RCATLayerPackage_Clipped.lpk".
+- **Clipping Network** (optional): Network to which all outputs will be clipped. If no clipping network is input, the layer package will include the entire network on which the model was run. Examples of possible clipping networks include a sub-watershed or the perennial network (if the model was run on a full network).
+
+### Outputs
+
+As you run the tool, you may see the layers being rapidly grouped in the Table of Contents, with the map changing accordingly. This is normal. Arcpy requires the layers to be added to the Table of Contents before they can be grouped, which leads to this odd-looking behavior. 
+
+After the tool is run, there should be a layer package file in the selected output folder. This file can be emailed or uploaded without breaking any links between the symbology and data sources.
+
+--------------------------------
+<div align="center">
+	<a class="hollow button" href="{{ site.baseurl }}/Documentation/Version_2.0/RCAT/6-RCA"><i class="fa fa-arrow-circle-left"></i> Back to Step 6 </a>
+</div>	
diff --git a/docs/Documentation/Version_2.0/index.md b/docs/Documentation/Version_2.0/index.md
@@ -20,6 +20,8 @@ Step 5. [Confinement Tool]({{ site.baseurl }}/Documentation/Verson_2.0/RCAT/5-Co
 
 Step 6. [Riparian Condition Assessment]({{ site.baseurl }}/Documentation/Version_2.0/RCAT/6-RCA)
 
+Step 7. [Layer Package Generator]({{ site.baseurl }}/Documentation/Version_2.0/RCAT/7-LayerPackageGenerator)
+
 > NOTE: RCAT Version 2.0 was developed using ArcMap 10.6.1 and tested on ArcMap 10.6.1 and ArcMap 10.7.1.
 
 ## Added flexibility in vegetation input classifications
@@ -69,6 +71,12 @@ These changes increase the accuracy of riparian conversion outputs and acknowled
 
 Fixed bugs in VBET and improved accuracy to minimize the need for manual editing. Added batch scripts for VBET in the supporting tools folder.
 
+## Added Layer Package Generator tool
+
+RCAT Version 2.0 generates layer files for all inputs, intermediates and outputs and incorporates a Layer Package Generator tool to gather layers into a layer package with consistent symbology and organization. 
+
+This addition allows users to easily review and share RCAT results.
+
 ## Improved toolbox linearity and project structure
 
 In RCAT Version 1.0, separate project folder structures were created for RCA and RVD, and the calculations for riparian vegetation departure were run in both RCA and RVD. 

diff --git a/docs/assets/images/LPG_interface_2.0.PNG b/docs/assets/images/LPG_interface_2.0.PNG