1D Integrity Tool - Revision history

Pavlina Monhartova at 07:28, 3 September 2025

2025-09-03T07:28:31Z

@@ Line 2: / Line 2: @@
 <br>
 __TOC__
 =Getting Started=
@@ Line 61: / Line 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]]

Pavlina Monhartova at 07:27, 3 September 2025

2025-09-03T07:27:15Z

← Older revision		Revision as of 17:27, 3 September 2025
Line 1:		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>		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.<br>
	<br>		<br>
	__TOC__		__TOC__

Pavlina Monhartova at 07:26, 3 September 2025

2025-09-03T07:26:50Z

← Older revision		Revision as of 17:26, 3 September 2025
Line 52:		Line 52:
	=Example Workflow and Tutorial=		=Example Workflow and Tutorial=
	* [[1D_Integrity_Tool_-_Tutorial\|1D Integrity Tool Tutorial]]		* [[1D_Integrity_Tool_-_Tutorial\|1D Integrity Tool Tutorial]]

	=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=		=Errors=

Pavlina Monhartova: /* General Overview */

2024-08-08T01:11:14Z

General Overview

← Older revision		Revision as of 11:11, 8 August 2024
Line 30:		Line 30:

	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>		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 input formats (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 exhibit incorrect output behviour. This is currently being updated and will be available in a future release.</b>''<Br><br>
	[[File:integrity_tool_overview.PNG]]<br>


	<ol>		<ol>

Emilie Nielsen: /* General Overview */

2024-01-30T04:59:40Z

General Overview

← Older revision		Revision as of 14:59, 30 January 2024
Line 29:		Line 29:
	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>		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 [[#Tool_Documentation\|Tool Documentation]] for information on each tool and [[#Example_Workflow_and_Tutorial\|Example Workflow and Tutorial]] for examples. <br><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 input formats (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 exhibit incorrect output behviour. This is currently being updated and will be available in a future release.</b>''<Br><br>		: ''<b>Note: The 1D integrity tool has not been tested yet with GPKG inputs. The main difference between GPKG and other input formats (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 exhibit incorrect output behviour. This is currently being updated and will be available in a future release.</b>''<Br><br>
	[[File:integrity_tool_overview.PNG]]<br>		[[File:integrity_tool_overview.PNG]]<br>
Line 43:		Line 43:
	<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).		<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>		</ol>


	=Tool Documentation=		=Tool Documentation=

Emilie Nielsen: /* Opening the 1D Integrity Tool */

2024-01-30T04:59:04Z

Opening the 1D Integrity Tool

← Older revision		Revision as of 14:59, 30 January 2024
Line 23:		Line 23:

	==Opening the 1D Integrity Tool==		==Opening the 1D Integrity Tool==
	After installing the QGIS TUFLOW plugin, the TUFLOW ~~Viewer~~ ~~tool~~ can be opened by clicking the following icon in the plugin toolbar:<br>		After installing the QGIS TUFLOW plugin, the TUFLOW 1D Integrity Tool can be opened by clicking the following icon in the plugin toolbar:<br>
	[[File: integrity_tool_in_toolbar.PNG]].<br>		[[File: integrity_tool_in_toolbar.PNG]].<br>


	=General Overview=		=General Overview=

Emilie Nielsen: /* Plugin Upgrades */

2024-01-30T04:58:36Z

Plugin Upgrades

← Older revision		Revision as of 14:58, 30 January 2024
Line 19:		Line 19:
	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>		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>		[[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 ]]</u>.		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]]</u>.
	<br><br>		<br><br>

Emilie Nielsen: /* Plugin Upgrades */

2024-01-30T04:58:29Z

Plugin Upgrades

← Older revision		Revision as of 14:58, 30 January 2024
Line 19:		Line 19:
	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>		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>		[[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~~ ]]</u>.		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 ]]</u>.
	<br><br>		<br><br>

Emilie Nielsen: /* Installation */

2024-01-30T04:57:32Z

Installation

← Older revision		Revision as of 14:57, 30 January 2024
Line 13:		Line 13:
	==Installation or Version Upgrade==		==Installation or Version Upgrade==
	===Installation===		===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 Plugin]]</u>.<br>		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>		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>

Tuflowduncan: /* Example Workflow and Tutorial */

2022-04-08T10:37:15Z

Example Workflow and Tutorial

← Older revision		Revision as of 20:37, 8 April 2022
Line 56:		Line 56:

	=Example Workflow and Tutorial=		=Example Workflow and Tutorial=
	* [[1D_Integrity_Tool_-_Tutorial\|1D Integrity Tool-Tutorial]]		* [[1D_Integrity_Tool_-_Tutorial\|1D Integrity Tool Tutorial]]

	=Planned Development=		=Planned Development=