Python Library TUFLOW Results - Revision history

Emilie Nielsen at 01:46, 8 January 2026

2026-01-08T01:46:43Z

← Older revision		Revision as of 11:46, 8 January 2026
Line 335:		Line 335:
	=Other Versions=		=Other Versions=
	An older version of the library that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results) is also available. This is currently undocumented, however, if you would like this please contact [mailto:support@tuflow.com support@tuflow.com].		An older version of the library that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results) is also available. This is currently undocumented, however, if you would like this please contact [mailto:support@tuflow.com support@tuflow.com].



			{{Tips Navigation
			\|uplink=[[TuPlot\| Back to TuPlot]]
			}}

Emilie Nielsen: /* Other Versions */

2025-02-20T06:29:18Z

Other Versions

← Older revision		Revision as of 16:29, 20 February 2025
Line 334:		Line 334:

	=Other Versions=		=Other Versions=
	An older version of the library that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results) is also available. This is currently undocumented, however, if you would like this please contact support@tuflow.com.		An older version of the library that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results) is also available. This is currently undocumented, however, if you would like this please contact [mailto:support@tuflow.com support@tuflow.com].

Par: /* Getting the TUFLOW results python library */

2018-05-10T05:48:13Z

Getting the TUFLOW results python library

← Older revision		Revision as of 15:48, 10 May 2018
Line 17:		Line 17:
	: If you select '''Clone or Download''' and then select '''Download Zip''' and save the .zip file, the TUFLOW_results.py sits inside the .zip file.</li>		: If you select '''Clone or Download''' and then select '''Download Zip''' and save the .zip file, the TUFLOW_results.py sits inside the .zip file.</li>
	<li>QGIS<br>		<li>QGIS<br>
	If you have QGIS2 with the TUFLOW plugin installed via the plugin repository, the TUFLOW_results.py sits within: C:\Users\<User Name>\.qgis2\python\plugins\tuflow<br>		: If you have QGIS2 with the TUFLOW plugin installed via the plugin repository, the TUFLOW_results.py sits within: C:\Users\<User Name>\.qgis2\python\plugins\tuflow<br>
	If you have QGIS3 with the TUFLOW plugin installed via the plugin repository, the TUFLOW_results.py sits within: C:\Users\<User Name>\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins\tuflow<br></li>		: If you have QGIS3 with the TUFLOW plugin installed via the plugin repository, the TUFLOW_results.py sits within: C:\Users\<User Name>\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins\tuflow<br></li>
	</ol>		</ol>
	The TUFLOW python library does not need to be installed in python (through pip or otherwise) like other common modules, the TUFLOW_results.py file just needs to be in the same location as your python project.		The TUFLOW python library does not need to be installed in python (through pip or otherwise) like other common modules, the TUFLOW_results.py file just needs to be in the same location as your python project.

	Note it shouldn’t matter if you’re using python 2 or python 3.		Note it shouldn’t matter if you’re using python 2 or python 3.

	=Dependencies=		=Dependencies=
	The TUFLOW results library calls a number of python modules, these are:		The TUFLOW results library calls a number of python modules, these are:

Par at 05:28, 10 May 2018

2018-05-10T05:28:12Z

← Older revision		Revision as of 15:28, 10 May 2018
Line 10:		Line 10:
	To make this data easier to work with an open source python library has been created and made available. This allows the user to load results and then interact with these. This library does not have any plotting functionality directly, with the returns typically being arrays (e.g. time and flows) however, the examples below give some examples using common plotting libraries such as matplotlib.<br>		To make this data easier to work with an open source python library has been created and made available. This allows the user to load results and then interact with these. This library does not have any plotting functionality directly, with the returns typically being arrays (e.g. time and flows) however, the examples below give some examples using common plotting libraries such as matplotlib.<br>
	=Getting the TUFLOW results python library=		=Getting the TUFLOW results python library=
	You can find the TUFLOW_results.py (previously TUFLOW_Results2016.py) on ~~our~~ ~~GitHub~~ repository, ~~QGIS~~ ~~plugin~~ repository, or if you have QGIS and the TUFLOW plugin installed, you will already have it on your computer.		You can find the TUFLOW_results.py (previously TUFLOW_Results2016.py) on the QGIS plugin repository, on the TUFLOW support GitHub repository or if you have QGIS and the TUFLOW plugin installed, you will already have it on your computer.
			<ol>

	~~GitHub~~: [https://~~github~~.~~com~~/~~TUFLOW-Support~~/~~QGIS-TUFLOW-Plugin~~ https://~~github~~.~~com~~/~~TUFLOW-Support~~/~~QGIS-TUFLOW-Plugin~~]<br>		<li>QGIS plugin repo: [https://plugins.qgis.org/plugins/tuflow/ https://plugins.qgis.org/plugins/tuflow/]<br>
			: If you select '''Download Latest''' and save the .zip file, the TUFLOW_results.py sits inside the .zip file.</li>
	QGIS plugin repo: [https://plugins.qgis.org/plugins/tuflow/ https://plugins.qgis.org/plugins/tuflow/]<br>
			<li>GitHub: [https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin QGIS plugin https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin]<br>
⚫	If you have QGIS2 ~~already~~: C:\Users\<User Name>\.qgis2\python\plugins\tuflow<br>
			: If you select '''Clone or Download''' and then select '''Download Zip''' and save the .zip file, the TUFLOW_results.py sits inside the .zip file.</li>

			<li>QGIS<br>
		⚫	If you have QGIS2 with the TUFLOW plugin installed via the plugin repository, the TUFLOW_results.py sits within: C:\Users\<User Name>\.qgis2\python\plugins\tuflow<br>
			If you have QGIS3 with the TUFLOW plugin installed via the plugin repository, the TUFLOW_results.py sits within: C:\Users\<User Name>\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins\tuflow<br></li>
			</ol>
	The TUFLOW python library does not need to be installed in python (through pip or otherwise) like other common modules, the TUFLOW_results.py file just needs to be in the same location as your python project.		The TUFLOW python library does not need to be installed in python (through pip or otherwise) like other common modules, the TUFLOW_results.py file just needs to be in the same location as your python project.

Par: /* Examples */

2018-05-10T05:05:37Z

Examples

← Older revision		Revision as of 15:05, 10 May 2018
Line 154:		Line 154:

	=Examples=		=Examples=
	These examples ~~can~~ be ~~downloaded~~ in .py ~~format~~ ~~along~~ ~~with~~ ~~the~~ ~~example~~ ~~results~~ ~~from~~ the TUFLOW website ~~(link required)~~.		These examples work with the Tutorial Model module 4 results. The tutorial model can be downloaded on the [https://www.tuflow.com/Tuflow%20Tutorial%20Models.aspx TUFLOW website].
	==Plot Flow in Channel==		==Plot Flow in Channel==
	<pre>		<pre>
Line 161:		Line 161:
	import matplotlib.pyplot as plt		import matplotlib.pyplot as plt
	import TUFLOW_results		import TUFLOW_results

			input_res = r'C:\TUFLOW\Models\Tutorials\QGIS\Complete_Model\TUFLOW\results\M04\2d\plot\M04_5m_001.tpc'

	# initialise the results class		# initialise the results class
Line 178:		Line 180:
	#Get flow data		#Get flow data
	chan_id = 'ds3' # this is the channel ID to use		chan_id = 'ds3' # this is the channel ID to use
	found, results, message = res.~~getTS~~(chan_id,'1D','Q','L')		found, results, message = res.getTSData(chan_id,'1D','Q','L')
	if found:		if found:
	print 'found requested data'		print('found requested data')
	# plot data		# plot data
	ax1.plot(res.times,results,color='b',label='Flow - '+chan_id)		ax1.plot(res.times,results,color='b',label='Flow - '+chan_id)
	else:		else:
	print message		print(message)
	sys.exit()		sys.exit()

Line 214:		Line 216:
	#Get water level data		#Get water level data
	for node_id in node_ids: #for each node in the list above		for node_id in node_ids: #for each node in the list above
	found, results, message = res.~~getTS~~(node_id,'1D','H','P')		found, results, message = res.getTSData(node_id,'1D','H','P')
	if found:		if found:
	print 'found requested data'		print('found requested data')
	# plot data		# plot data
	ax1.plot(res.times,results,label='Level - '+node_id)		ax1.plot(res.times,results,label='Level - '+node_id)
	else:		else:
	print message		print(message)
	sys.exit()		sys.exit()

Line 248:		Line 250:

	#Get flow data		#Get flow data
	found, results, message = res.~~getTS~~(chan_id,'1D','Q','L')		found, results, message = res.getTSData(chan_id,'1D','Q','L')
	if found:		if found:
	print 'found requested data'		print('found requested data')
	ax1.plot(res.times,results,color='b',label='Flow - '+chan_id)		ax1.plot(res.times,results,color='b',label='Flow - '+chan_id)
	else:		else:
	print message		print(message)
	sys.exit()		sys.exit()

	#Get velocity data		#Get velocity data
	found, results, message = res.~~getTS~~(chan_id,'1D','V','L')		found, results, message = res.getTSData(chan_id,'1D','V','L')
	if found:		if found:
	print 'found requested data'		print('found requested data')
	ax2.plot(res.times,results,color='r',label='Velocity - '+chan_id)		ax2.plot(res.times,results,color='r',label='Velocity - '+chan_id)
	else:		else:
	print message		print(message)
	sys.exit()		sys.exit()

Line 289:		Line 291:
	error, message = res.LP_getConnectivity(us_chan,ds_chan)		error, message = res.LP_getConnectivity(us_chan,ds_chan)
	if error:		if error:
	print message		print(message)
	sys.exit()		sys.exit()
	else:		else:
	print 'LP connectivity determined.'		print('LP connectivity determined.')

	print 'Get LP static data'		print('Get LP static data')
	error, message = res.LP_getStaticData()		error, message = res.LP_getStaticData()
	if error:		if error:
	print message		print(message)
	sys.exit()		sys.exit()
	else:		else:
	print 'LP static data retrieved'		print('LP static data retrieved')

	#create plot		#create plot

Par: Par moved page Python Library TUFLOW Results 2016 to Python Library TUFLOW Results: Renamed library

2018-05-10T04:52:29Z

Par moved page Python Library TUFLOW Results 2016 to Python Library TUFLOW Results: Renamed library

← Older revision		Revision as of 14:52, 10 May 2018
(No difference)

Par at 04:46, 10 May 2018

2018-05-10T04:46:44Z

← Older revision		Revision as of 14:46, 10 May 2018
Line 1:		Line 1:
	[[File:TUPython.png \| 435px]]		[[File:TUPython.png \| 435px]]

	'''THIS PAGE IS PRESENTLY BEING UPGRADED'''
	=Introduction=		=Introduction=
	For the 2016 version of TUFLOW a new output format for time-series was made available, this has the following changes from previous versions:		For the 2016 version of TUFLOW a new output format for time-series was made available, this has the following changes from previous versions:
Line 10:		Line 9:
	This is the default approach for the 2016 version but can be modified with the TUFLOW command "<tt>Output Approach == Pre 2016</tt>" (refer to the manual for more information on this command.<br>		This is the default approach for the 2016 version but can be modified with the TUFLOW command "<tt>Output Approach == Pre 2016</tt>" (refer to the manual for more information on this command.<br>
	To make this data easier to work with an open source python library has been created and made available. This allows the user to load results and then interact with these. This library does not have any plotting functionality directly, with the returns typically being arrays (e.g. time and flows) however, the examples below give some examples using common plotting libraries such as matplotlib.<br>		To make this data easier to work with an open source python library has been created and made available. This allows the user to load results and then interact with these. This library does not have any plotting functionality directly, with the returns typically being arrays (e.g. time and flows) however, the examples below give some examples using common plotting libraries such as matplotlib.<br>
			=Getting the TUFLOW results python library=
			You can find the TUFLOW_results.py (previously TUFLOW_Results2016.py) on our GitHub repository, QGIS plugin repository, or if you have QGIS and the TUFLOW plugin installed, you will already have it on your computer.

			GitHub: [https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin]<br>
			QGIS plugin repo: [https://plugins.qgis.org/plugins/tuflow/ https://plugins.qgis.org/plugins/tuflow/]<br>
			If you have QGIS2 already: C:\Users\<User Name>\.qgis2\python\plugins\tuflow<br>

			The TUFLOW python library does not need to be installed in python (through pip or otherwise) like other common modules, the TUFLOW_results.py file just needs to be in the same location as your python project.

			Note it shouldn’t matter if you’re using python 2 or python 3.
	=Dependencies=		=Dependencies=
	The TUFLOW results library calls a number of python ~~libraries~~, these are:		The TUFLOW results library calls a number of python modules, these are:
	* csv		* csv
	* numpy		* numpy
	* os		* os
	* sys		* sys
	Of these the csv, os and sys functionality should be available directly with the python install. Depending on the method used to install python numpy may need to be installed. If installation of numpy is required, please refer to the numpy documentation [http://www.numpy.org/ http://www.numpy.org/].		Of these the csv, os and sys functionality should be available directly with the python install. Depending on the method used to install python, numpy may need to be installed. If installation of numpy is required, please refer to the numpy documentation [http://www.numpy.org/ http://www.numpy.org/].
	=Compatible Python Versions=		=Compatible Python Versions=
	The functionality has been developed for Python 2.7, but should be compatible with Python 3.5. Other versions of python are currently untested.		The functionality has been developed for Python 2.7, but should be compatible with Python 3.5. Other versions of python are currently untested.
Line 24:		Line 32:
	==Import==		==Import==
	This library is imported with the typical python syntax.<br>		This library is imported with the typical python syntax.<br>
	<pre>import ~~TUFLOW_results2016~~</pre>		<pre>import TUFLOW_results</pre>
	==Initialise Results (ResData)==		==Initialise Results (ResData)==
	The results data functionality has a class defined, this is named '''ResData'''. An instance of the results can be initialised with the following syntax:		The results data functionality has a class defined, this is named '''ResData'''. An instance of the results can be initialised with the following syntax:
	<pre>res = ~~TUFLOW_results2016~~.ResData()</pre>		<pre>res = TUFLOW_results.ResData()</pre>
	==Defined Methods (Functions)==		==Defined Methods (Functions)==
	The following are the defined '''functions''' in the results data class (ResData).		The following are the defined '''functions''' in the results data class (ResData).
Line 45:		Line 53:
	<li>Domain - The domain to return the results for, this will be one of '''1D''', '''2D''' or '''RL''' (for reporting location data)</li>		<li>Domain - The domain to return the results for, this will be one of '''1D''', '''2D''' or '''RL''' (for reporting location data)</li>
	<li>Results Type - The results type to be returned. This includes H (level), Q (flow), V (velocity), E (energy), QA (flow area) depending on the data types that have been output!</li>		<li>Results Type - The results type to be returned. This includes H (level), Q (flow), V (velocity), E (energy), QA (flow area) depending on the data types that have been output!</li>
	<li>Geometry - The GIS geometry of the object, '''L''' for line, or '''P''' for point. If unsure or unknown this can be set to a ~~dummy~~ string such as '~~dummy~~'.</li>		<li>Geometry - The GIS geometry of the object, '''L''' for line, or '''P''' for point. If unsure or unknown this can be set to a blank string such as ''.</li>
	The return arguments are:		The return arguments are:
	<li>found (logical) - Returns True if the data has been found, False if the data can not be found or an error has occurred.</li>		<li>found (logical) - Returns True if the data has been found, False if the data can not be found or an error has occurred.</li>
Line 152:		Line 160:
	import sys #system functions		import sys #system functions
	import matplotlib.pyplot as plt		import matplotlib.pyplot as plt
	import ~~TUFLOW_results2016~~		import TUFLOW_results

	# initialise the results class		# initialise the results class
	res = ~~TUFLOW_results2016~~.ResData()		res = TUFLOW_results.ResData()

	# Load the data and terminate if error returned		# Load the data and terminate if error returned
Line 318:		Line 326:
	This will create a figure that looks like the above.<br>		This will create a figure that looks like the above.<br>

	==Long Profile with additional data==
	To be completed.
	==Plotting Results from Multiple Simulations==
	To be completed.
	=Other Versions=		=Other Versions=
	An older version of the library that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results) is also available. This is currently undocumented, however, if you would like this please contact support@tuflow.com.		An older version of the library that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results) is also available. This is currently undocumented, however, if you would like this please contact support@tuflow.com.

Ellis Symons: /* Plot Flow in Channel */

2018-01-10T00:03:33Z

Plot Flow in Channel

← Older revision		Revision as of 10:03, 10 January 2018
Line 155:		Line 155:

	# initialise the results class		# initialise the results class
	res = ~~TUFLOW_results2015~~.ResData()		res = TUFLOW_results2016.ResData()

	# Load the data and terminate if error returned		# Load the data and terminate if error returned
Line 193:		Line 193:
	This will create a figure that looks like the above.		This will create a figure that looks like the above.
	<br>		<br>

	==Plot Multiple Water Levels==		==Plot Multiple Water Levels==
	In this example, it is assumed that the results data has been loaded as per the above.		In this example, it is assumed that the results data has been loaded as per the above.

Mitch3007 at 23:14, 10 November 2016

2016-11-10T23:14:41Z

← Older revision		Revision as of 09:14, 11 November 2016
Line 1:		Line 1:
	[[File:TUPython.png \| ~~440px~~]]		[[File:TUPython.png \| 435px]]

	'''THIS PAGE IS PRESENTLY BEING UPGRADED'''		'''THIS PAGE IS PRESENTLY BEING UPGRADED'''

Mitch3007 at 23:14, 10 November 2016

2016-11-10T23:14:17Z

← Older revision		Revision as of 09:14, 11 November 2016
Line 1:		Line 1:
	[[File:TUPython.png \| ~~430px~~]]		[[File:TUPython.png \| 440px]]

	'''THIS PAGE IS PRESENTLY BEING UPGRADED'''		'''THIS PAGE IS PRESENTLY BEING UPGRADED'''