1D Integrity Tool: Difference between revisions

Browse history interactively

← Older edit

Content deleted Content added

VisualWikitext

Revision as of 00:29, 6 April 2022 view source Ellis Symons (talk \| contribs) Bureaucrats, Administrators 3,095 edits No edit summary ← Older edit		Latest revision as of 17:28, 3 September 2025 view source Pavlina Monhartova (talk \| contribs) Bureaucrats, Administrators 5,384 edits No edit summary
(13 intermediate revisions by 4 users not shown)
Line 1: The 1D Integrity Tool is a suite of tools that help modellers find and fix potential errors in 1D networks prior to running TUFLOW. The tool was primarily designed for (large) underground pipe networks, but can be used for all 1D channel types, however not all checks will be available. The tool is designed to be fast and provide automated fixes as well as visualisations to help the process~~. The tool is undergoing constant development and a list of [[#Planned_Development\|planned features]] can be found at the bottom of the page~~.<br> <br> __TOC__ <br>▼ {{Tips Navigation▼ \|uplink=[[TUFLOW_QGIS_Plugin#Usage\| Back to TUFLOW QGIS Plugin Main Page]]▼ }}▼ ~~<br>~~ ~~<br>~~ =Getting Started= ==Installation or Version Upgrade== ===Installation=== The 1D Integrity Tool is a free tool that comes as part of the TUFLOW plugin in QGIS. For instructions on how to install the plugin, please follow these steps:<u>[[TUFLOW_QGIS_Plugin#Installation_of_Plugin \| Installation of TUFLOW QGIS Plugin]]</u>.<br> There are also instructions on installing plugins in the QGIS documentation - if you choose to follow the QGIS documentation, the plugin is called "TUFLOW" in the repository: <u> [https://docs.qgis.org/3.16/en/docs/training_manual/qgis_plugins/fetching_plugins.html Link to QGIS Documentation - Installing and Managing Plugins]</u>.<br> Line 19 ⟶ 12: It's recommended to upgrade the plugin whenever a new version is released. The upgrade process is typically done via the Plugin Manager ('''QGIS Drop Menu: Plugins >> Manage and Install Plugins''').<br> [[File: TUFLOW Plugin Update.JPG\|\|600px]]<br><br> If you encounter an error while upgrading the plugin please follow these steps: <u>[[ TUFLOW_QGIS_Plugin#Error_While_Upgrading_Plugin \| ~~Error_While_Upgrading_Plugin~~Error While Upgrading Plugin]]</u>. <br><br> ==Opening the 1D Integrity Tool== After installing the QGIS TUFLOW plugin, the TUFLOW ~~Viewer~~1D ~~tool~~Integrity Tool can be opened by clicking the following icon in the plugin toolbar:<br> [[File: integrity_tool_in_toolbar.PNG]].<br> =General Overview= The 1D Integrity tool is designed to accept multiple inputs and will treat all inputs holistically as a complete system. Each tool is designed to be run separately and progressively as part of the entire tool suite. It is assumed that most of the channel attribute data has been populated, most importantly that each channel has been given a valid type.<br> See <u>[[#Tool_Documentation\|Tool Documentation]]</u> for information on each tool and <u>[[#Example_Workflow_and_Tutorial\|Example Workflow and Tutorial]]</u> for examples. <br><Br> : ''<b>Note: The 1D integrity tool has not been tested yet with GPKG inputs. The main difference between GPKG and other inputs (such as shp or memory layers) is that there is an additional attribute 'FID' generally located before the other attributes. This may cause the tool to not work, error, or strange output behviour. This is currently being updated and will be available in future release.</b>''<Br><br> ~~[[File:integrity_tool_overview.PNG]]<br>~~ <ol> Line 44 ⟶ 33: <li> '''Run''' - runs the currently active tool (active tool determined by the current active tool tab - prior to plugin version 3.2 a radio button was used to select the active tool). </ol> =Tool Documentation= Line 56 ⟶ 44: =Example Workflow and Tutorial= * [[1D_Integrity_Tool_-_Tutorial\|1D Integrity Tool Tutorial]] ~~Coming soon.~~ ~~=Planned Development=~~ ~~The following items are currently planned future developments:~~ * Edit pipe attributes within the long plot * Auto correct continuity errors - use a set of rules to correct continuity errors * Inference tool - tool to fill in missing data such as pipe inverts based on a set of rules =Errors= Line 73 ⟶ 54: Occassionally you may receive an uncaught error, appearing as a yellow banner at the top of the QGIS window. Similar to the above process, please select 'Stack trace' and email a copy of the text and (if possible) the inputs used in the integrity tool to [mailto:support@tuflow.com support@tuflow.com].<br> [[File:integrity_tool_python_error.PNG]] ▲<br> ▲{{Tips Navigation ▲\|uplink=[[TUFLOW_QGIS_Plugin#Usage\| Back to TUFLOW QGIS Plugin Main Page]] ▲}}