Difference between revisions of "TUFLOW QGIS Plugin"
Ellis Symons (talk | contribs) (→Usage) |
|||
(59 intermediate revisions by 6 users not shown) | |||
Line 14: | Line 14: | ||
<li>Before using, check that the prerequisite python modules are also installed (see below). | <li>Before using, check that the prerequisite python modules are also installed (see below). | ||
</ol><br> | </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= | = Prerequisites= | ||
Line 35: | Line 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. | 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. | ||
− | + | === Editing Tools === | |
<ol> | <ol> | ||
<li> [[QGIS_TUFLOW_Create_Project | Create or Configure TUFLOW Project]]</li> | <li> [[QGIS_TUFLOW_Create_Project | Create or Configure TUFLOW Project]]</li> | ||
Line 41: | Line 46: | ||
<li> [[QGIS_TUFLOW_Insert_TUFLOW_Attributes_to_Existing_Layer | Insert TUFLOW Attributes to Existing Layer]]</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> | ||
+ | <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> | ||
− | + | === Run Tools === | |
<ol> | <ol> | ||
<li> [[QGIS_TUFLOW_Run_TUFLOW | Run TUFLOW simulation]]</li> | <li> [[QGIS_TUFLOW_Run_TUFLOW | Run TUFLOW simulation]]</li> | ||
− | <li> Running TUFLOW Utilities | + | <li> [[TUFLOW_Runner | TUFLOW Runner]]</li> |
+ | <li> [[QGIS_TUFLOW_Run_TUFLOW_Utilities | Running TUFLOW Utilities]]</li> | ||
</ol> | </ol> | ||
− | + | ||
+ | === Visualisation Tools === | ||
<ol> | <ol> | ||
<li> [[TUFLOW_Viewer | TUFLOW Viewer ]](result visualisation toolkit) | <li> [[TUFLOW_Viewer | TUFLOW Viewer ]](result visualisation toolkit) | ||
<li> [[QGIS_TUFLOW_Styles | Applying TUFLOW styles]] | <li> [[QGIS_TUFLOW_Styles | Applying TUFLOW styles]] | ||
<li> [[QGIS_TUFLOW_Import_Check_Files_From_Folder | Import Check Files From Folder]] | <li> [[QGIS_TUFLOW_Import_Check_Files_From_Folder | Import Check Files From Folder]] | ||
− | <li> Load TUFLOW Layers From TCF | + | <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> | </ol> | ||
− | + | === Hydrology Tools === | |
<ol> | <ol> | ||
<li> [[QGIS_ARR_to_TUFLOW | ARR to TUFLOW]] | <li> [[QGIS_ARR_to_TUFLOW | ARR to TUFLOW]] | ||
Line 60: | Line 74: | ||
<li> [[QGIS_SCS_to_TUFLOW | SCS to TUFLOW]] | <li> [[QGIS_SCS_to_TUFLOW | SCS to TUFLOW]] | ||
</ol> | </ol> | ||
− | '''SWAN GIS Tools''' | + | === 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> | <ol> | ||
− | <li> | + | <li> [https://fvwiki.tuflow.com/index.php?title=SWAN_GIS_Model_Builder SWAN GIS Model Builder] |
− | <li> | + | <li> [https://fvwiki.tuflow.com/index.php?title=SWAN_GIS_Post_Processing SWAN GIS Post Processing] |
</ol> | </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_Convert_XPSWMM_Hydrology_(beta) | Convert - XPSWMM Hydrology (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]] | ||
− | If you encounter any issues with the plugin please | + | </ol> |
+ | </ol> | ||
+ | |||
+ | If you encounter any issues with the plugin please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u>.<br> | ||
<br> | <br> | ||
Line 79: | Line 121: | ||
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. | 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=== | + | === 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> | 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> | <ol> | ||
Line 85: | Line 127: | ||
<li>'''Linux''' - /home/USER/.local/share/QGIS/QGIS3/profiles/default/python/plugins | <li>'''Linux''' - /home/USER/.local/share/QGIS/QGIS3/profiles/default/python/plugins | ||
</ol> | </ol> | ||
+ | |||
+ | =Changelog= | ||
+ | |||
+ | [https://docs.tuflow.com/qgis-tuflow-plugin/changelog/ https://docs.tuflow.com/qgis-tuflow-plugin/changelog/] | ||
<br> | <br> | ||
{{Tips Navigation | {{Tips Navigation | ||
|uplink=[[QGIS_Tips| Back to QGIS Tips Main Page]] | |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 09:51, 10 May 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:
- Download the plugin from the QGIS official repository, Plugins >> Manage and Install Plugins
- In the manager, search for "TUFLOW".
- Select TUFLOW, and "Install Plugin".
- Once enabled the plugin should be accessible from the Plugins >> TUFLOW menu item:
- 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:
- Install the TUFLOW plugin (see instructions above)
- Open the TUFLOW plugin Plugins >> TUFLOW
- Check that the required dependencies are installed from the menu. TUFLOW >> About >> Check Python Dependencies Installed.
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.
- 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)
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
- Create or Configure TUFLOW Project
- Import Empty (template GIS file)
- Insert TUFLOW Attributes to Existing Layer
- Increment Selected Layer
- Reload Data
- Arch Bridge Editor
- Copy TUFLOW Command
Run Tools
Visualisation Tools
- TUFLOW Viewer (result visualisation toolkit)
- Applying TUFLOW styles
- Import Check Files From Folder
- Load TUFLOW Layers From TCF
- Filter and Sort TUFLOW Layers
- Apply GPKG Layer Names
- Apply Label to Current Layer
- Apply Stability Styling
Hydrology Tools
Integrity Tools
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:
Processing Toolbox
- Convert TUFLOW Model GIS Format
- Package Model
- SWMM Tools:
- BC - Create channel endpoint 1D/2D connections
- Conduits - Assign losses
- Conduits - Assign node fields
- Convert - ESTRY layers to SWMM
- Convert - XPSWMM GIS inlet layers to SWMM
- Convert - XPSWMM Hydrology (beta)
- GeoPackage - Add sections
- GeoPackage - Create
- GeoPackage - Create from SWMM inp
- GeoPackage - Write to SWMM inp
- Integrity - Make object names unique
- Junctions - Convert HX Nodes to Storage
- Junctions - Downstream junctions to outfalls
- Junctions - Set attributes
- Outfalls - Fix multiply connected links
If you encounter any issues with the plugin please contact support@tuflow.com.
Error While Upgrading Plugin
If you receive an error while trying to upgrade the TUFLOW plugin you may need to either:
- Restart QGIS and try upgrading the plugin again
- 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):
- Windows - %appdata%\QGIS\QGIS3\profiles\default\python\plugins
- Linux - /home/USER/.local/share/QGIS/QGIS3/profiles/default/python/plugins
Changelog
https://docs.tuflow.com/qgis-tuflow-plugin/changelog/
Up |
---|
Back to QGIS Tips Main Page |
Up |
---|
Back to Wiki Main Page |