PyTuflow: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
Ellis Symons (talk | contribs) |
|||
| (128 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
=Introduction= |
|||
=Class: ResData= |
|||
PyTUFLOW is a library that acts as an API for your TUFLOW model. It allows easy interaction with the model results, contains a number of useful utilities for building TUFLOW models, and contains some useful parsers for files within the TUFLOW eco-system. |
|||
==Latest Documentation== |
|||
Class for TUFLOW time series results. |
|||
The PyTUFLOW documentation has moved to a new location: <u>[https://docs.tuflow.com/pytuflow/ PyTUFLOW Documentation]</u>. |
|||
The previous PyTUFLOW API has been deprecated and the wiki documentation has been archived. However, if needed, the archived documentation can still be accessed via the link in the section below. |
|||
Initialised as an empty object, or with results with a *.tpc in TUFLOW 2016 release and later or *.info in TUFLOW 2013 release. |
|||
==Archive Documentation== |
|||
<pre> |
|||
Guidance for earlier version of PyTuflow can be accessed via the following link: <u>[[PyTuflow_Archive| PyTuflow_Archive]]</u>. |
|||
import pytuflow as tu |
|||
<br> |
|||
{{Tips Navigation |
|||
res = tu.ResData() # initialising as an empty object |
|||
|uplink=[[Main_Page| Back to Wiki Main Page]] |
|||
| ⚫ | |||
# or |
|||
res = tu.ResData('M01_5m_001.tpc') # initialising with results |
|||
</pre> |
|||
'''Methods''' |
|||
{|class="wikitable" style="text-align: center;" |
|||
! style="background-color:#005581; font-weight:bold; color:white" width=20%| Method |
|||
|! style="background-color:#005581; font-weight:bold; color:white;" width=30%|Description |
|||
|! style="background-color:#005581; font-weight:bold; color:white;" width=20%|Inputs |
|||
|! style="background-color:#005581; font-weight:bold; color:white;" width=20%|Returns |
|||
|- |
|||
|rowspan='1'|<b>channelConnectionCount</b> |
|||
|rowspan='1'|Returns the number of channels connected to a given node |
|||
|str Node ID |
|||
|int Count |
|||
|- |
|||
|rowspan='1'|<b>channelConnections</b> |
|||
|rowspan='1'|Returns a list of the channels connected to a given node |
|||
|str Node ID |
|||
|list -> str Channel ID |
|||
| ⚫ | |||
Latest revision as of 12:55, 19 December 2025
Introduction
PyTUFLOW is a library that acts as an API for your TUFLOW model. It allows easy interaction with the model results, contains a number of useful utilities for building TUFLOW models, and contains some useful parsers for files within the TUFLOW eco-system.
Latest Documentation
The PyTUFLOW documentation has moved to a new location: PyTUFLOW Documentation.
The previous PyTUFLOW API has been deprecated and the wiki documentation has been archived. However, if needed, the archived documentation can still be accessed via the link in the section below.
Archive Documentation
Guidance for earlier version of PyTuflow can be accessed via the following link: PyTuflow_Archive.
| Up |
|---|
 Back to Wiki Main Page
|