View source for TUFLOW QGIS Plugin

=Introduction=
This page describes the process of running the TUFLOW QGIS plugin.  At this stage it is still a beta and once we have tested it further it will be made available for the official QGIS repository...  Please report any issues or feedback to support@tuflow.com.<br><br>
The plugin is available for both QGIS 1.8 and QGIS 2.0.  As there were some changes to the QGIS Python API [https://hub.qgis.org/wiki/17/Python_plugin_API_changes_from_18_to_20 see here for those interested] the versions are not interchangeable (though they have the same functionality).<br>
<br>
=Installation=
<ol>
To enable the plugin please follow the instuctions below:
<li>Download the plugin...</li>
</ol>
=Prerequisites=
The plugin uses the following python modules...

=Use=
<ol>
<li>Step 1 is to check that the required dependencies are installed.  To do this run TUFLOW > About > Check Python Dependencies Installed from the menu.  All going well you will get a notification to tell you that the required modules are installed.</li>
<li>The next step is to configure a TUFLOW project.  This is project dependent and stores the location of the TUFLOW executable, working directory and projection.  This can be accessed from TUFLOW > Editing > Configure TUFLOW Project.<br>
[[File:QgisTuflow Configure01.JPG|400px]]
<br><br>
This saves the information in the QGIS project.  This information is used later, for example when you use the Run TUFLOW, the utility defaults to running the most recent .tcf file in the specified TUFLOW directory, defined at this step.<br>
'''Note:''' The location specified, should be the folder that contains (or will contain) the TUFLOW folder.  For example if the TUFLOW directory is "L:\Projects\Dummy\Modelling\TUFLOW\" then "L:\Projects\Dummy\Modelling\" should be defined in this dialogue.</li>
<li>After configuring the project ensure you save your project.</li>
</ol>
==Create TUFLOW directory==
The first step in creating a TUFLOW model is typically to create a TUFLOW directory structure, define a projection file and run TUFLOW to create the empty (template) TUFLOW files.  This can be done in a single step using the TUFLOW > Editing > Create TUFLOW directory tool.<br>
[[File:QgisTuflow CreateDirectory.JPG|400px]]
<br>
<br>
The TUFLOW folder will be created under this location.  If the "Run TUFLOW to create empties" is checked, after creating the folder structure, a TUFLOW simulation will be started which creates the empty (template) files under the "TUFLOW\model\gis\empty\" folder.

</ol>