PyTuflow: Difference between revisions
Content deleted Content added
Ellis Symons (talk | contribs) |
Ellis Symons (talk | contribs) No edit summary |
||
Line 84:
|''tuple'' time series data ( ''list'' x data, ''list'' y data )
|-
|rowspan='2'|<b>[[#load|load]] (</b> ''str'' filepath <b>)</b>
|rowspan='2'|Loads result file. File formats are *.tpc for TUFLOW release 2016 and later, or *.info for TUFLOW release 2013
|''bool'' Error
Line 731:
:::: e.g. ([0, 1, 2, 3, 4, 5], [10, 20, 30, 20, 10, 0]
'''Example'''
==load==
<b>load (</b> Filepath <b>)</b><br>
Loads result file. File formats are *.tpc for TUFLOW release 2016 and later, or *.info for TUFLOW release 2013<br>
;Parameters:
: '''Filepath:''' ''str''
:: Full path to *.tpc or *.info
;Returns:
: '''Error:''' ''bool''
:: Returns False on success, returns True if an error occurred
: '''Message:''' ''str''
:: Accompanying error message if an error occurs
'''Example'''
<pre>
import pytuflow as tu
# Initialise result class
res = tu.ResData()
# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)
# check if an error occurred
if err:
# print message
print(message)
</pre>
| |||