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.

The plugin is available for version 2.x, a previous version was available for QGIS 1.8, however, this is no longer being actively developed.

Prerequisites

The 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, you can install the plugin (see instructions below) and 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. If not, you will be notified if you need to install either of the the python modules below:
Please ensure QGIS / python is installed before installing the below.

• 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)

A number of other python modules are required, however, these should be installed with QGIS / python.

Installation of Plugin

To enable the plugin please follow the instructions below:
1. Make sure you have QGIS installed and the prerequisites installed (see above).
2. Download the plugin, from the GitHub repository a direct link to the zip file is:
https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin/archive/master.zip
3. Extract the zip file and then copy or move the "TUFLOW" folder into your QGIS plugin directory. This should be "C:\Users\<username>\.qgis2\python\plugins"
4. Open QGIS and from the menu select Plugins >> Manage and Install Plugins.... In the manager, find the plugin "TUFLOW" and select the check box to enable the plugin.
300px
5. Once enabled the plugin should be accessible from the Plugin >> TUFLOW menu item:
File:QgisTuflow Menu.jpg

Usage

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

Editing Tools

1. Create or Configure TUFLOW Project
2. Import Empty (template GIS file
3. Increment Selected Layer
Visualisation Tools

4. View Results
5. View Cross-Sections
Run Tools

6. Run TUFLOW simulation

The first step for a project is to create the project / save the settings with the Create or Configure TUFLOW Project tool. Subsequent tools rely on the information stored at this stage to work best.
If you encounter any issues with the plugin please email support@tuflow.com.