Difference between revisions of "TUFLOW QGIS Plugin"

From Tuflow
Jump to navigation Jump to search
Line 15: Line 15:
 
[[File:QGIS_TUFLOW_001.PNG|400px]]
 
[[File:QGIS_TUFLOW_001.PNG|400px]]
 
<li>Once enabled the plugin should be accessible from the '''Plugins >> TUFLOW''' menu item:</li>
 
<li>Once enabled the plugin should be accessible from the '''Plugins >> TUFLOW''' menu item:</li>
[[File:QGIS TUFLOW Menu 2016329.PNG]]
+
[[File:QGIS_TUFLOW_003.PNG|600px]]
 
<li>Before using, check that the prerequisite python modules are also installed.
 
<li>Before using, check that the prerequisite python modules are also installed.
 
</ol>
 
</ol>

Revision as of 09:21, 26 April 2016

This page is currently being updated

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. A previous version was available for QGIS 1.8, however, this is no longer being actively developed.

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

Installation of Plugin

To enable the plugin please follow the instructions below:

  1. Download the plugin from the QGIS official repository, Plugins >> Manage and Install Plugins
  2. QGIS TUFLOW 000.PNG
  3. In the manager, search for "TUFLOW".
  4. Select TUFLOW, and "Install Plugin".
  5. QGIS TUFLOW 001.PNG
  6. Once enabled the plugin should be accessible from the Plugins >> TUFLOW menu item:
  7. QGIS TUFLOW 003.PNG
  8. Before using, check that the prerequisite python modules are also installed.

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:

  1. install the TUFLOW plugin (see instructions above)
  2. Open the TUFLOW plugin Plugins >> TUFLOW
  3. Check that the required dependencies are installed from the menu. TUFLOW > About > Check Python Dependencies Installed.
  4. 600px

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:
Please ensure QGIS / python is installed before installing the below.

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
  4. Run Tools
  5. Run TUFLOW simulation
  6. Visualisation Tools
  7. TuPlot (View results and cross-sections)
  8. Applying TUFLOW styles

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.