Tuflow

ArcTUFLOW Toolbox and Toolbar: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
 
(27 intermediate revisions by 5 users not shown)
Line 1:
<font size=3><b>THIS PAGE IS CURRENTLY UNDERGOING UPDATES</b></font>
 
=Introduction=
A TUFLOW toolbox is available for ArcMap 10.1 and newer (if you are using ArcGIS Pro, please refer to <u>[[ArcGIS_TUFLOW_Toolbar | ArcGIS Pro TUFLOWToolbar]]</u>). This toolbox helps with streamlining the process of creating and editing a TUFLOW model in ArcMap. A Toolbar has also been developed to accompany the toolbox to further increase efficiency and workflow. The toolbar shortcuts the opening of the toolbox utilities to a single click on an easily accessible toolbar.
 
These utilities can be downloaded from the TUFLOW website: http://www.tuflow.com/Tuflow%20Utilities.aspx▼
* [https://www.tuflow.com/downloads/#utilities Download Link]
 
The download contains both the .esriaddin and the ArcTUFLOW Toolbox. The .esriaddin is a stand alone toolbar add-in to ArcMap and (as suggested) is a stand alone item that does not need to be kept with the other contents of the download. The .tbx is the ArcTUFLOW Toolbox and should be kept with the other folders contained in the download.
▲These utilities can be downloaded from the TUFLOW website: http://www.tuflow.com/Tuflow%20Utilities.aspx
 
=Installation=
Line 10 ⟶ 11:
* [[TUFLOW_ArcGIS_Toolbox_and_Toolbar_Installation | How to install ArcTUFLOW Toolbox and Toolbar]]<br><br>
 
=The Utilities: What are they, and How to use them, and Workflow=
 
The descriptionsArcTUFLOW below, and their orderTools are intended to help the user with model initiation, setup and development, running, and checking and viewing results:
 
[[File: ArcTUFLOW_Toolbox_Toolbar_comb.PNG]]<br>
Line 18 ⟶ 19:
{| class="wikitable"
 
! style="background-color:#005581; font-weight:bold; color:white;" width=52% | Model Stage
! style="background-color:#005581; font-weight:bold; color:white;" width=10% | Utilities
! style="background-color:#005581; font-weight:bold; color:white;" width=20% | Description
|-
|Start Model Build || 1. [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW (Required Initialization Step)]]
2. [[#Create_TUFLOW_Folders | Create TUFLOW Folders]]<br>
| This is the first step of any new model or ArcGIS workspace. Using the '''Configure TUFLOW''' utility will create a ''_config.txt'' file that will pre-populate fields in the other utilities that speed up their use. The '''Create TUFLOW Folders''' utility can also be used to create the TUFLOW folder structure and empty SHP files.
|-
|Model Build and Development || 3. [[#Import_Empty_(template)_TUFLOW_Files| Import Empty (template) TUFLOW Files]]<br>
Line 34 ⟶ 33:
9. [[#Change_Attribute_Data_Type | Change Attribute Data Type]]<br>
10. [[#Correct_Pipe_Direction | Correct Pipe Direction]]<br>
XX. [[#Extract_ARR2016_to_TUFLOW | Extract ARR2016 to TUFLOW]] - coming soon<br>
|These utilities are used in the model development stage to speed up creation of TUFLOW layers. Using the '''Import Empty''' utility enables the user to quickly add empty SHP layers, and the '''Increment Layer''' utility allows the user to rev up TUFLOW layers as the model progresses in iterations. Other utilities such as '''Create Breakline''' automate some of the more time consuming steps in the model build.
|-
|Running TUFLOW || 11. [[#Run_TUFLOW_Simulation | Run TUFLOW Simulation]]<br> || The '''Run TUFLOW Simulation''' utility can be used to set off TUFLOW simulations from ArcGIS.
|-
|Loading and Viewing Results || 12. [[#Load_Simulation_Input_Files | Load Simulation Input Files]]<br>
13. [[#TUPLOTLabel_Selected_Layer | TUPLOTLabel Selected Layer]] - Toolbar only<br>
14. [[#TUPLOT | TUPLOT]] - Toolbar only
| These utilities are intended for the purpose of checking and reviewing input files and viewing 1D and time series results. The '''Load Simulation Input Files''' utility allows the user to load in the input SHP files and CHECK files from a simulation for review. And <b>TUPLOT</b> introduces the functionality currently available in QGIS to ArcGIS for viewing 1D and time series results.
|-
|Miscellaneous || 1415. [[#About | About]] ||
|}<br>
 
Line 56 ⟶ 53:
 
==Create TUFLOW Folders==
The tool "Create TUFLOW Folders" will create the standard TUFLOW folder structure and generate empty TUFLOW template files.
 
This tool is best used if [[ArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.
 
[[File: ArcTUFLOW_CreateTUFLOWFolders.PNG]]
 
==Import Empty (template) TUFLOW Files==
Line 64 ⟶ 66:
*Specify the run ID for the file. This will be added to the file name as a suffix.
<br>
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
[[File:ArcGIS_Utility_007.jpg|400px]]
 
Line 76 ⟶ 78:
* Specify a run ID for the file. This will be added to the name as a suffix
 
This tool is best used if [[#Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] has been run prior.
 
[[File: ArcTUFLOW_InsertTUFLOWattributes.PNG]]
Line 113 ⟶ 115:
* Specify a search radius for considering neighbouring elevation values if using a statistical approach to elevation extraction - leave blank to extract elevation from immediate cell
* Specify a statistical operation (must be coupled with a search radius). Options include:
** 'MAXMAXIMUM'
** 'MINMINIMUM'
** 'MEAN'
 
Line 133 ⟶ 135:
==Correct Pipe Direction==
 
The "Correct Pipe Direction" tool will reverse the direction of all lines within a layer based on the upstream and downstream invert levels. Based on the invert levels, the tool will reverse any line that has an adverse gradient, with the assumption that the line has been digitised in the wrong direction. It will also switch the upstream and downstream invert attributes to correct them after reversing the line direction.
==Extract ARR2016 to TUFLOW==
 
Coming Soon
The steps are:
* Select an input pipe layer
* Select the fields which represent the upstream and downstream invert levels
 
[[File: ArcTUFLOW_CorrectPipeDir.PNG]]
 
==Run TUFLOW Simulation==
Line 141 ⟶ 148:
* Define the path to the TUFLOW executable
<br>
The ArcTUFLOW toolbox requires configuring prior to using this tool. Refer to [[Configure_TUFLOWArcTUFLOW_Configure_TUFLOW | Configure TUFLOW]] for more instructions. <br><br>
[[File:ArcGIS_Utility_008.jpg|400px]]
 
Line 147 ⟶ 154:
 
This tool loads all input shp files from a model simulation into a common ArcGIS Map window.<br>
The user has the option of which files to import from the simulation.
The [[ArcTUFLOW_Run_TUFLOW_Simulation | ArcTUFLOW Run TUFLOW Simulation]] example does not provide an input (.tlf) to complete this example. This section relates to users who have run their own Tutorial, Demo, Example or personal models.
 
[[File: ArcTUFLOW ImportSimFiles.PNG]]
* After completing your model run, enter the simulation tlf reference
[[File:arcTUFLOW_Load_Simulation_File.JPG|600px]]
<br>
<br>
Line 157 ⟶ 163:
<br><br>
This tool is courtesy of Wood Rodgers, Inc. (www.woodrodgers.com)
 
==Label Selected Layer==
 
This tool will auto label the selected layer in the TOC. If the selected layer is a TUFLOW layer (e.g. 1d_nwk) the tool will automatically apply an expression, displaying useful information about the layer. It can also be used on non-TUFLOW layers, however will only label the first attribute. The user also has the option of changing the label colour from the adjacent drop down box (default is black if no colour is selected).
 
This tool is useful for reviewing models as well as building.
 
==TUPLOT==
 
TUPLOT is a 1D and 2D time series results viewer. A full description on how to use it is below:
* [[TUPLOT_External | How to use TUPLOT]]
 
==About==
Displays version of ArcTUFLOW.
 
<br>
Retrieved from "https://wiki.tuflow.com/ArcTUFLOW_Toolbox_and_Toolbar"