The QGIS-TUFLOW plugin is a collection of tools to assist with the building and visualisation of TUFLOW models. These plugins can be used with Crayfish to enable the visualisation the 2D timeseries output from TUFLOW.

If you have any suggestions please email us as at support@tuflow.com

• Readme.md - You're here

• /qgis_plugin/tuflow - contains the main core of the plugin.

• /utilities/ - location for functionality / libraries that can be re-used elsewhere (e.g. a python lib that's also a script).

These plugins are currently only available for QGIS 2.0 and above. We are no longer supporting a TUFLOW plugin for 1.8. As part of the QGIS install python should already be installed on your machine.

To enable please save the .zip file to your QGIS plugin directory and then unzip. This zip folder will contain a number folders as outlined above.

The tuflow folder from QGIS-TUFLOW-Plugin-master.zip\QGIS-TUFLOW-Plugin-master\qgis_plugin\tuflow should sit directly plugin folder i.e.

C:\Users\<username>\.qgis2\python\plugins\tuflow\

Alternatively you can clone the repository from github, although you will need to unpack into the directory structure above.

When you open QGIS the plugin should load itself. If not, you can enable it from Plugin > Manage and Install plugins window. This can be found under

Plugins >> TUFLOW

To check you have the required dependencies please run the following tool:

Plugins >> TUFLOW >> About >> Check Python Dependencies Installed.

If additional dependencies are required, these should be listed in the dialogue. The main dependencies are:

• matplotlib

  You can download matplotlib from here and install it in the usual way.

• numpy

  You can download numpy from here and install it in the usual way.

  Alternatively, you can install them from OSGeo4W package manager.