View source for TUFLOW QGIS Plugin

=Introduction=
This page describes the process of installing and using the TUFLOW QGIS plugin. The Plugin is available via the official QGIS repository. The plugin is available for version 2.x and more recent. A previous version was available for QGIS 1.8, however, this is no longer being actively developed.
<br>  

Please report any issues or feedback to support@tuflow.com.<br><br>

=Installation of Plugin=
To enable the plugin please follow the instructions below:
<ol>
<li>Download the plugin from the QGIS official repository,  '''Plugins >> Manage and Install Plugins'''</li>
[[File:QGIS_TUFLOW_000.PNG|400px]]
<li>In the manager, search for "TUFLOW".</li>
<li>Select TUFLOW, and "Install Plugin".</li>
[[File:QGIS_TUFLOW_001.PNG|400px]]
<li>Once enabled the plugin should be accessible from the '''Plugins >> TUFLOW''' menu item:</li>
[[File:QGIS_TUFLOW_003.PNG|400px]]
<li>Before using, check that the prerequisite python modules are also installed (see below).
</ol>

=Error While Upgrading Plugin=
If you receive an error while trying to upgrade the TUFLOW plugin you may need to either:<br>
<ol>
<li> Restart QGIS and try upgrading the plugin again
<li> Manually remove the old version
</ol>

Errors are most likely caused by an issue with deleting the old version of the plugin as some part of the plugin is still being used somewhere in memory (RAM) and locking permissions. This is a known issue with the ReFH2 to TUFLOW tool and simply restarting QGIS and retrying the upgrade process should fix the issue.

===Manually removing the TUFLOW plugin===
To manually remove the TUFLOW plugin simply delete the 'tuflow' folder from the QGIS plugin directory (you may need to close QGIS first):<br>
<ol>
<li>'''Windows''' - %appdata%\QGIS\QGIS3\profiles\default\python\plugins
<li>'''Linux''' - /home/USER/.local/share/QGIS/QGIS3/profiles/default/python/plugins
</ol>

== Prerequisites==
The TUFLOW plugin uses the following python modules which '''may''' need to be separately installed.  These may have been installed with other software, to check if they are installed on your machine: 
<ol>
<li> Install the TUFLOW plugin (see instructions above)</li>
<li> Open the TUFLOW plugin '''Plugins >> TUFLOW''' </li>
<li> Check that the required dependencies are installed from the menu. '''TUFLOW >> About >> Check Python Dependencies Installed'''.  </li>
[[File:QGIS_TUFLOW_004.PNG|600px]]
</ol>

All going well you will get a notification to tell you that the required modules are installed. If not, you will be notified if you need to install either of the python modules below:<br>
Please ensure QGIS / python is installed before installing the below.<br>
* numpy (see http://sourceforge.net/projects/numpy/files/NumPy/1.6.1/numpy-1.6.1-win32-superpack-python2.7.exe/download)
* matplotlib (see http://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.1.0/matplotlib-1.1.0.win32-py2.7.exe/download)

=Usage=
Each function in the utility has a separate page documenting the usage. 

The first step for a project is to create the project / save the settings with the [[QGIS_TUFLOW_Create_Project | Create or Configure TUFLOW Project]] tool.  Subsequent tools rely on the information stored at this stage to work best. 

'''Editing Tools'''<br>
<ol>
<li> [[QGIS_TUFLOW_Create_Project | Create or Configure TUFLOW Project]]</li>
<li> [[QGIS_TUFLOW_Import_Empty | Import Empty (template GIS file)]]</li>
<li> [[QGIS_TUFLOW_Increment_Layer | Increment Selected Layer]]</li>
<li> Convert MapInfo file to Shapefile </li>
<li> Convert MapInfo files in folder to Shapefile </li>
</ol>
'''Run Tools'''<br>
<ol>
<li> [[QGIS_TUFLOW_Run_TUFLOW | Run TUFLOW simulation]]</li>
</ol>
'''Visualisation Tools'''<br>
<ol>
<li> [[TUFLOW_Viewer | TUFLOW Viewer (View 1D and 2D results)]]</li>
<li> [[QGIS_TUFLOW_Styles | Applying TUFLOW styles]]</li>
</ol>
'''ARR2016 to TUFLOW'''<br>
<ol>
<li> [[QGIS_ARR2016_to_TUFLOW | Extract ARR2016 to TUFLOW]]
</ol>
'''ReFH2 to TUFLOW'''<br>
<ol>
<li> [[QGIS_ReFH2_to_TUFLOW | ReFH2 to TUFLOW]]
</ol>

<br>
If you encounter any issues with the plugin please email support@tuflow.com.