Difference between revisions of "TUFLOW QGIS Plugin"

From Tuflow
Jump to navigation Jump to search
(111 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
=Introduction=
 
=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>
+
If you are using QGIS as your model development or result viewing environment we strongly recommend installing the TUFLOW QGIS Plugin. It includes numerous tools to increase workflow efficiency. It also includes powerful result viewing functionality via its <u>[[TUFLOW_Viewer | TUFLOW Viewer]]</u>. This page describes the process of installing and using the Plugin.  
−
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.
+
<br>  
−
<br>
+
=Installation of Plugin=
−
=Prerequisites=
+
To enable the plugin please follow the instructions below:
−
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:<br>
+
<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><br>
 +
 
 +
=Development Version=
 +
It's possible to test out the latest development version of the plugin and TUFLOW Viewer by following the instructions below:<br>
 +
<b><u>[[Installing_the_Latest_Development_Version_of_the_TUFLOW_Plugin | Installing the Latest Development Version of the TUFLOW Plugin]]</u></b>
 +
<br><br>
 +
 
 +
= 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>
 
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)
 
* 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)
 
* 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.
+
<br>
  
−
=Installation of Plugin=
+
=Usage=
−
<ol>
+
Each function in the utility has a separate page documenting the usage.  
−
To enable the plugin please follow the instructions below:
 
−
<li>Make sure you have QGIS installed and the prerequisites installed (see above).</li>
 
−
<li>Download the plugin, from the [https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin GitHub repository] a direct link to the zip file is:</li>
 
−
https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin/archive/master.zip
 
  
−
<li>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"</li>
+
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.  
−
<li>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.</li>
 
−
[[File:QgisTuflow PluginManager.JPG|300px]]
 
−
<li>Once enabled the plugin should be accessible from the '''Plugin >> TUFLOW''' menu item:</li>
 
−
[[File:QgisTuflow Menu.jpg]]
 
−
</ol>
 
  
−
=Usage=
+
=== Editing Tools ===
−
Each function in the utility has a separate page documenting the usage. 
 
 
<ol>
 
<ol>
−
'''Editing Tools'''<br>
 
 
<li> [[QGIS_TUFLOW_Create_Project | Create or Configure TUFLOW Project]]</li>
 
<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_Import_Empty | Import Empty (template GIS file)]]</li>
 +
<li> [[QGIS_TUFLOW_Insert_TUFLOW_Attributes_to_Existing_Layer | Insert TUFLOW Attributes to Existing Layer]]</li>
 
<li> [[QGIS_TUFLOW_Increment_Layer | Increment Selected Layer]]</li>
 
<li> [[QGIS_TUFLOW_Increment_Layer | Increment Selected Layer]]</li>
−
'''Visualisation Tools'''<br>
+
<li> [[QGIS_TUFLOW_Reload_Data | Reload Data]]
−
<li> [[QGIS_TUFLOW_View_Results | View Results]]</li>
+
<li> [[QGIS_TUFLOW_Arch_Bridge_Editor | Arch Bridge Editor]]
−
<li> [[QGIS_TUFLOW_View_Sections | View Cross-Sections]]</li>
+
<li> [[QGIS_TUFLOW_Copy_TUFLOW_Command | Copy TUFLOW Command]]
−
'''Run Tools'''<br>
+
</ol>
 +
=== Run Tools ===
 +
<ol>
 
<li> [[QGIS_TUFLOW_Run_TUFLOW | Run TUFLOW simulation]]</li>
 
<li> [[QGIS_TUFLOW_Run_TUFLOW | Run TUFLOW simulation]]</li>
 +
<li> [[TUFLOW_Runner | TUFLOW Runner]]</li>
 +
<li> [[QGIS_TUFLOW_Run_TUFLOW_Utilities | Running TUFLOW Utilities]]</li>
 
</ol>
 
</ol>
−
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.
+
 
 +
=== Visualisation Tools ===
 +
<ol>
 +
<li> [[TUFLOW_Viewer | TUFLOW Viewer ]](result visualisation toolkit)
 +
<li> [[QGIS_TUFLOW_Styles | Applying TUFLOW styles]]
 +
<li> [[QGIS_TUFLOW_Import_Check_Files_From_Folder | Import Check Files From Folder]]
 +
<li> [[QGIS_TUFLOW_Load_Layers_From_TCF | Load TUFLOW Layers From TCF]]
 +
<li> [[QGIS_TUFLOW_Filter_and_Sort_TUFLOW_Layers | Filter and Sort TUFLOW Layers]]
 +
<li> [[QGIS_TUFLOW_Apply_GPKG_Layer_Names | Apply GPKG Layer Names]]
 +
<li> [[QGIS_TUFLOW_Apply_Label_to_Current_Layer | Apply Label to Current Layer]]
 +
<li> [[QGIS_TUFLOW_Apply_Stability_Styling | Apply Stability Styling]]
 +
</ol>
 +
=== Hydrology Tools ===
 +
<ol>
 +
<li> [[QGIS_ARR_to_TUFLOW | ARR to TUFLOW]]
 +
<li> [[QGIS_ReFH2_to_TUFLOW | ReFH2 to TUFLOW]]
 +
<li> [[QGIS_SCS_to_TUFLOW | SCS to TUFLOW]]
 +
</ol>
 +
=== Integrity Tools ===
 +
<ol>
 +
<li> [[1D_Integrity_Tool | 1D Integrity Tool]]
 +
</ol>
 +
=== SWAN GIS Tools ===
 +
For more information on SWAN GIS Tools please visit the following TUFLOW FV Wiki page: '''<u>[https://fvwiki.tuflow.com/index.php?title=SWAN_GIS_Tools SWAN GIS Tools]</u>'''. Links to the individual tools on the TUFLOW FV Wiki area also provided below:
 +
<ol>
 +
<li> [https://fvwiki.tuflow.com/index.php?title=SWAN_GIS_Model_Builder SWAN GIS Model Builder]
 +
<li> [https://fvwiki.tuflow.com/index.php?title=SWAN_GIS_Post_Processing SWAN GIS Post Processing]
 +
</ol>
 +
=== Processing Toolbox ===
 +
<ol>
 +
<li> [[Convert_TUFLOW_Model_GIS_Format | Convert TUFLOW Model GIS Format]]
 +
<li> [[Package_Model_in_QGIS | Package Model]]
 +
<li> SWMM Tools:
 +
<ol><li>[[QGIS_SWMM_BC_Create_Channel_Endpoint_1D/2D_Connections | BC - Create channel endpoint 1D/2D connections]]
 +
<li> [[QGIS_SWMM_Conduits_Assign_Losses | Conduits - Assign losses]]
 +
<li> [[QGIS_SWMM_Conduits_Assign_Node_Fields | Conduits - Assign node fields]]
 +
<li> [[QGIS_SWMM_Convert_ESTRY_Layers_To_SWMM | Convert - ESTRY layers to SWMM]]
 +
<li> [[QGIS_SWMM_Convert_XPSWMM_GIS_Inlet_Layers_to_SWMM | Convert - XPSWMM GIS inlet layers to SWMM]]
 +
<li> [[QGIS_SWMM_GeoPackage_Add_Sections | GeoPackage - Add sections]]
 +
<li> [[QGIS_SWMM_GeoPackage_Create | GeoPackage - Create]]
 +
<li> [[QGIS_SWMM_GeoPackage_Create_from_SWMM_inp | GeoPackage - Create from SWMM inp]]
 +
<li> [[QGIS_SWMM_GeoPackage_Write_to_SWMM_inp | GeoPackage - Write to SWMM inp]]
 +
<li> [[QGIS_SWMM_Integrity_Make_Object_Names_Unique| Integrity - Make object names unique]]
 +
<li> [[QGIS_SWMM_Junctions_Downstream_Junctions_to_Outfalls| Junctions - Downstream junctions to outfalls]]
 +
<li> [[QGIS_SWMM_Junctions_Set_Attributes| Junctions - Set attributes]]
 +
<li> [[QGIS_SWMM_Outfalls_Fix_Multiply_Connected_Links| Outfalls - Fix multiply connected links]]
 +
 
 +
</ol>
 +
</ol>
 +
 
 +
If you encounter any issues with the plugin please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u>.<br>
 +
<br>
 +
 
 +
=Error While Upgrading Plugin=
 +
[[File:Plugin_uninstall_failed.PNG]]<br>
 +
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 that occur with the ReFH2 to TUFLOW tool in older versions of the plugin. 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>
 +
 
 +
=Changelog=
 +
 
 +
[https://docs.tuflow.com/qgis-tuflow-plugin/changelog/ https://docs.tuflow.com/qgis-tuflow-plugin/changelog/]
 +
 
 
<br>
 
<br>
−
If you encounter any issues with the plugin please email support@tuflow.com.
+
{{Tips Navigation
 +
|uplink=[[QGIS_Tips| Back to QGIS Tips Main Page]]
 +
}}
 +
<br><br><br><br>
 +
{{Tips Navigation
 +
|uplink=[[Main_Page| Back to Wiki Main Page]]
 +
}}

Revision as of 20:10, 19 April 2024

Introduction

If you are using QGIS as your model development or result viewing environment we strongly recommend installing the TUFLOW QGIS Plugin. It includes numerous tools to increase workflow efficiency. It also includes powerful result viewing functionality via its TUFLOW Viewer. This page describes the process of installing and using the Plugin.

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
  2. In the manager, search for "TUFLOW".
  3. Select TUFLOW, and "Install Plugin".
    4. QGIS TUFLOW 001.PNG
  4. Once enabled the plugin should be accessible from the Plugins >> TUFLOW menu item:
    5. QGIS TUFLOW 003.PNG
  5. Before using, check that the prerequisite python modules are also installed (see below).


Development Version

It's possible to test out the latest development version of the plugin and TUFLOW Viewer by following the instructions below:
Installing the Latest Development Version of the TUFLOW Plugin

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. QGIS TUFLOW 004.PNG

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.

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.

Editing Tools

  1. Create or Configure TUFLOW Project
  2. Import Empty (template GIS file)
  3. Insert TUFLOW Attributes to Existing Layer
  4. Increment Selected Layer
  5. Reload Data
  6. Arch Bridge Editor
  7. Copy TUFLOW Command

Run Tools

  1. Run TUFLOW simulation
  2. TUFLOW Runner
  3. Running TUFLOW Utilities

Visualisation Tools

  1. TUFLOW Viewer (result visualisation toolkit)
  2. Applying TUFLOW styles
  3. Import Check Files From Folder
  4. Load TUFLOW Layers From TCF
  5. Filter and Sort TUFLOW Layers
  6. Apply GPKG Layer Names
  7. Apply Label to Current Layer
  8. Apply Stability Styling

Hydrology Tools

  1. ARR to TUFLOW
  2. ReFH2 to TUFLOW
  3. SCS to TUFLOW

Integrity Tools

  1. 1D Integrity Tool

SWAN GIS Tools

For more information on SWAN GIS Tools please visit the following TUFLOW FV Wiki page: SWAN GIS Tools. Links to the individual tools on the TUFLOW FV Wiki area also provided below:

  1. SWAN GIS Model Builder
  2. SWAN GIS Post Processing

Processing Toolbox

  1. Convert TUFLOW Model GIS Format
  2. Package Model
  3. SWMM Tools:
    1. BC - Create channel endpoint 1D/2D connections
    2. Conduits - Assign losses
    3. Conduits - Assign node fields
    4. Convert - ESTRY layers to SWMM
    5. Convert - XPSWMM GIS inlet layers to SWMM
    6. GeoPackage - Add sections
    7. GeoPackage - Create
    8. GeoPackage - Create from SWMM inp
    9. GeoPackage - Write to SWMM inp
    10. Integrity - Make object names unique
    11. Junctions - Downstream junctions to outfalls
    12. Junctions - Set attributes
    13. Outfalls - Fix multiply connected links

If you encounter any issues with the plugin please contact support@tuflow.com.

Error While Upgrading Plugin

Plugin uninstall failed.PNG
If you receive an error while trying to upgrade the TUFLOW plugin you may need to either:

  1. Restart QGIS and try upgrading the plugin again
  2. Manually remove the old version

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 that occur with the ReFH2 to TUFLOW tool in older versions of the plugin. 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):

  1. Windows - %appdata%\QGIS\QGIS3\profiles\default\python\plugins
  2. Linux - /home/USER/.local/share/QGIS/QGIS3/profiles/default/python/plugins

Changelog

https://docs.tuflow.com/qgis-tuflow-plugin/changelog/


Up
Go-up.png Back to QGIS Tips Main Page





Up
Go-up.png Back to Wiki Main Page
Retrieved from "https://wiki.tuflow.com/w/index.php?title=TUFLOW_QGIS_Plugin&oldid=39336"