TUFLOW QGIS Plugin: Difference between revisions
Content deleted Content added
| (84 intermediate revisions by 7 users not shown) | |||
Line 1:
=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 <u>[[TUFLOW_Viewer | TUFLOW Viewer]]</u>. This page describes the process of installing and using the Plugin.
<br>
=Installation of Plugin=
To enable the plugin please follow the instructions below:
Line 16 ⟶ 13:
[[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>
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>
Line 29 ⟶ 31:
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
* matplotlib (see
<br>
=Usage=
Line 37 ⟶ 40:
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.
<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_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_Reload_Data | Reload Data]]
<li> [[QGIS_TUFLOW_Arch_Bridge_Editor | Arch Bridge Editor]]
<li> [[QGIS_TUFLOW_Copy_TUFLOW_Command | Copy TUFLOW Command]]
</ol>
<ol>
<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>
<li> [[TUFLOW_Viewer | TUFLOW Viewer ]](
<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> [[
<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> [[Create_TUFLOW_Project | Create TUFLOW Project]]
<li> [[Package_Model_in_QGIS | Package Model]]
<li> [[QGIS_TIN_Polygons_Assign_Elevations | TIN Polygons - Assign Elevations]]
<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_Convert_XPSWMM_Hydrology_(beta) | Convert - XPSWMM Hydrology (beta)]]
<li> [[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX | Convert - XPSWMM model from XPX (beta)]]
<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_Convert_HX_Nodes_to_Storage| Junctions - Convert HX nodes to storage]]
<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
<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>
{{Tips Navigation
▲If you encounter any issues with the plugin please email support@tuflow.com.
|uplink=[[QGIS_Tips| Back to QGIS Tips Main Page]]
}}
<br><br><br><br>
{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}
| |||