View source for QGIS TUFLOW Run TUFLOW Utilities

This tool offers a basic graphical user interface for the '''<u>[[TUFLOW_Utilities | TUFLOW Utilities]]</u>'''. Users can choose to use the interface for common use cases or use the advanced tab to use batch file commands directly. The tool also has a convenient option to automatically download the latest version of each utility.
<br>
==Running the Tool==
The tool can be found in the TUFLOW Plugin toolbar, or via the QGIS menu '''Plugins >> TUFLOW >> TUFLOW Utilities'''.
<br>
[[File: TUFLOW_Utilities_ToolIcon.PNG]]
<br><br>
==Common Functions==
Prior to running any of the tools, the tool must have access to the TUFLOW Utilities. This is done via the '''<u>[[#Executables | Executables]]</u>''' tab.
<Br><br>
The available utilities for '''Common Functions''' can be selected via the "Utility" dropbox at the top of the dialog. All utilities have optional output options:<Br>
* '''Output Directory''' - directory to write the tool outputs. This option will generally not have affect unless an output name is also specified.
* '''Output Name''' - output name of tool outputs. This can be specified independently of an output directory. (''Note: prior to version 3.3 of the TUFLOW Plugin, output name required an output directory as well'')
* '''Save as Batch File''' - Saves the next run function as a batch file. The batch file will be saved into the output directory if one is specified, otherwise it will be saved to the same location as the other outputs.
<Br>
'''Asc_to_Asc'''<br>
Asc_to_Asc supports ASC and FLT raster formats. The following functions are available for asc_to_asc (inputs must have the same cell size and extents):
* '''Difference''' - Takes the difference between 2 grids. Must specify an input for "Grid 1" and "Grid 2". '''<u>[[ASC_to_ASC#Difference | More information... ]]</u>'''
* '''Maximum''' - Computes the maximum of all input grids for each grid cell. Must add at least one grid via "Add Grids To Function". '''<u>[[ASC_to_ASC#Maximum | More information...]]</u>'''
* '''Statistics''' - Computes a range of statistics of all input grids for each grid cell. Must add at least 2 grids via "Add Grids To Function". '''<u>[[ASC_to_ASC#Statistics | More information...]]</u>'''
* '''Convert''' - Converts all inputs grids between ASC and FLT (the output format is dependent on the input format). Must add at least one grid via "Add Grids To Function". '''<u>[[ASC_to_ASC#Convert | More information...]]</u>'''
<Br>
'''TUFLOW_to_GIS'''<br>
TUFLOW_to_GIS supports DAT or XMDF inputs and supports ASC and SHP as output formats. Users must specify an input XMDF or DAT file if running any of the functions. For XMDF inputs, the tool has the option to load XMDF information that will populate the available result types and timesteps. The following functions are available for TUFLOW_to_GIS:
* '''Convert to Grid''' - Converts the DAT, or specified result type from an XMDF, at the chosen timestep to an ASC raster.
* '''Convert to Point''' - Converts the DAT, or specified result type from an XMDF, at the chosen timestep to a Shape File vector point layer.
* '''Convert to Vectors''' - Converts the DAT, or specified result type from an XMDF, at the chosen timestep to a Shape File vector polygon layer shaped as arrows. The arrow geometry is defined by the direction and magnitude of the input. The input must be of type vector (e.g. Velocity, Unit Flow).
<Br>
'''Res_to_Res'''<Br>
Res_to_Res supports DAT or XMDF inputs and supports XMDF or DAT output formats. The following functions are available for Res_to_Res :<Br>
* '''Info''' - Reads the XMDF header and outputs the information in an output window. Must specify an XMDF file in the "XMDF or DAT File" input. '''<u>[[RES_to_RES#XMDF_Information | More information... ]]</u>'''
* '''Convert''' - Converts between XMDF and DAT formats. The output format is dependent on the input format. Must specify an XMDF or DAT file in the "XMDF or DAT File" input. For XMDF, must also specify a type using the dropbox. Users can also manually enter text here if the desired result type isn't listed. '''<u>[[RES_to_RES#Convert | More information... ]]</u>'''
* '''Maximum''' - Calculates the maximum from a number of different inputs. Must specify at least one XMDF or DAT via "Add XMDF or DAT to Function". For XMDF inputs, must also specify a type using the dropbox. Users can also manually enter text here if the desired result type isn't listed. Input mesh layers mush have the same mesh (.2dm file). '''<u>[[RES_to_RES#Max | More information... ]]</u>'''
* '''Concatenate''' - Joins separate output files together into a single XMDF file. Must specify at least one XMDF or DAT via "Add XMDF or DAT to Function". For XMDF inputs, must also specify a type using the dropbox. Users can also manually enter text here if the desired result type isn't listed. Input mesh layers mush have the same mesh (.2dm file). '''<u>[[RES_to_RES#Concatenate | More information... ]]</u>'''


==Advanced==
Prior to running the tool from the advanced tab, the tool must have access to the TUFLOW Utilities. This is done via the '''<u>[[#Executables | Executables]]</u>''' tab.
<Br><br>
The advanced tab allows users to enter pass commands directly to the utilities as if they were using a batch file, however with the convenience of not having to actually create a batch file. If already working in QGIS, then the workflow is not interrupted and the final commands can be exported to a batch file for future use. The utility should be selected from the dropdown box at the top of the dialog. It is recommended that users select a working directory. A working directory lets the users pass relative references to inputs via the argument text box. Arguements are entered under "Flags and Values" and should be identical to what are entered through a batch file with the exception that the utility exe location is not required and the batch file flag '-b' is also automatically added.<br>
<Br>
Users can also use the "Find File" for convenience. The chosen file(s) will be automatically added to the arguments text box. If a working directory is present, the input files will automatically be inserted with a relative referene to the working directory.

==Executables==
todo