Difference between revisions of "Python Library TUFLOW Results"
Line 18: | Line 18: | ||
=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. | ||
− | = | + | =Usage= |
+ | |||
==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_results2016</pre> | ||
==Initialise Results (ResData)== | ==Initialise Results (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_results2016.ResData()</pre> | ||
− | ==Load Results== | + | ==Defined Methods (Functions)== |
+ | The following are the defined '''functions''' in the results data class (ResData). | ||
+ | ===Load Results=== | ||
Results are loaded in with the syntax below. | Results are loaded in with the syntax below. | ||
<pre>error, message = res.Load(r'D:\TUFLOW\QGIS\test\plot\Plot_Example.tpc')</pre> | <pre>error, message = res.Load(r'D:\TUFLOW\QGIS\test\plot\Plot_Example.tpc')</pre> | ||
Line 31: | Line 34: | ||
* error (logical) set to True if an error has been encountered. | * error (logical) set to True if an error has been encountered. | ||
* message (string), if an error has occurred the message string will be populated with an error message. | * message (string), if an error has occurred the message string will be populated with an error message. | ||
− | ==Get Time-series== | + | ===Get Time-series=== |
Time-series at a 1D, 2D or reporting location can be returned using the following syntax: | Time-series at a 1D, 2D or reporting location can be returned using the following syntax: | ||
<pre> | <pre> | ||
Line 51: | Line 54: | ||
Will return flow (Q) data for the 1D channel with ID ds3. The optional 'L' geometry indicates that this is stored on a line object in the GIS plot objects. | Will return flow (Q) data for the 1D channel with ID ds3. The optional 'L' geometry indicates that this is stored on a line object in the GIS plot objects. | ||
'''Note''' As the time data typically does not change (this is not a return argument) but can be accessed by the <tt>res.times</tt>. See the examples below. | '''Note''' As the time data typically does not change (this is not a return argument) but can be accessed by the <tt>res.times</tt>. See the examples below. | ||
− | ==Long Profile Functions== | + | ===Long Profile Functions=== |
When dealing with 1D long profile data, if a single 1D channel is specified the data for all channels downstream will returned. If two channels are specified, long profile data will only be returned for the channels between the specified channels. | When dealing with 1D long profile data, if a single 1D channel is specified the data for all channels downstream will returned. If two channels are specified, long profile data will only be returned for the channels between the specified channels. | ||
− | ===Get Long Profile Connectivity (LP_getConnectivity)=== | + | ====Get Long Profile Connectivity (LP_getConnectivity)==== |
This determines and stores the connectivity of the specified channels. This is used in later routines to determine the channels and nodes to plot for the long profile. The syntax is: | This determines and stores the connectivity of the specified channels. This is used in later routines to determine the channels and nodes to plot for the long profile. The syntax is: | ||
<pre>error, message = res.LP_getConnectivity(<US Channel ID>,<US Channel ID or None>)</pre> | <pre>error, message = res.LP_getConnectivity(<US Channel ID>,<US Channel ID or None>)</pre> | ||
Line 71: | Line 74: | ||
</pre> | </pre> | ||
Determines the channels between '''FC01.40''' and '''ds3''', an error will be returned if these channels are not connected. | Determines the channels between '''FC01.40''' and '''ds3''', an error will be returned if these channels are not connected. | ||
− | ===Get Long Profile Static Data (LP_getStaticData)=== | + | ====Get Long Profile Static Data (LP_getStaticData)==== |
Once the connectivity between two channels has been determined, this routine can be used to get data that does not change between time-steps. This includes: | Once the connectivity between two channels has been determined, this routine can be used to get data that does not change between time-steps. This includes: | ||
* distance information | * distance information | ||
Line 81: | Line 84: | ||
<li>error (logical) - Returns True if an error has been encountered when detecting the connectivity between the specified channel(s).</li> | <li>error (logical) - Returns True if an error has been encountered when detecting the connectivity between the specified channel(s).</li> | ||
<li>message (string) - If an error is returned this message string contains information on the issue.</li> | <li>message (string) - If an error is returned this message string contains information on the issue.</li> | ||
− | ===Get Long Profile Data (LP_getData)=== | + | ====Get Long Profile Data (LP_getData)==== |
This function gets data at a specific time. If looping through timesteps (e.g. for an animation) the channel connectivity and static data will not change between timesteps and therefore only the '''LP_getData''' will need to be repeated. The syntax is: | This function gets data at a specific time. If looping through timesteps (e.g. for an animation) the channel connectivity and static data will not change between timesteps and therefore only the '''LP_getData''' will need to be repeated. The syntax is: | ||
<pre> | <pre> | ||
Line 97: | Line 100: | ||
</pre> | </pre> | ||
Returns the water level (head) data at time 1 hours using a search tolerance of 0.01 hours. | Returns the water level (head) data at time 1 hours using a search tolerance of 0.01 hours. | ||
+ | ==Other Attributes== | ||
+ | Once initialised the ResData class also has a number of '''attributes''' associated with it as well as the '''defined functions''' described above, these are outlined in the table below. | ||
+ | {| align="center" class="wikitable" | ||
+ | ! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Attribute Name | ||
+ | ! style="background-color:#005581; font-weight:bold; color:white;" width=25% | Type | ||
+ | ! style="background-color:#005581; font-weight:bold; color:white;" width=50% | Description | ||
+ | |- | ||
+ | |script_version|| string || Contains a version number of the TUFLOW results library, e.g. '2016-01-AA' | ||
+ | |- | ||
+ | |filename|| string|| The full filepath to the .tpc file. | ||
+ | |- | ||
+ | |fpath|| string|| The path of the folder which contains the .tpc file. | ||
+ | |- | ||
+ | |nTypes|| integer|| The number of data types that are stored in the dataset. | ||
+ | |- | ||
+ | |Types || list || A lists of the data types that are stored in the dataset. | ||
+ | |- | ||
+ | |LP || class (LP) || Contains Long profile information, connectivity, distances etc. | ||
+ | |- | ||
+ | |Data_1D|| class(Data_1D) || The 1D results are all stored in this class. | ||
+ | |- | ||
+ | |Data_2D|| class(Data_2D) || The 2D results are all stored in this class. | ||
+ | |- | ||
+ | |Data_RL|| class(Data_RL) || The reporting location results are all stored in this class. | ||
+ | |- | ||
+ | |GIS|| class(GIS)|| This contains the information read in from the <tt>GIS Plot Layer</tt> csv files. | ||
+ | |- | ||
+ | |formatVersion|| integer || The format version of the results as defined in the .tpc file. | ||
+ | |- | ||
+ | |units || string || The units as defined in the .tpc. E.g. "Metric" or "English" | ||
+ | |- | ||
+ | |displayname || string || The simulation name e.g. "M04_5m_001_2015" | ||
+ | |- | ||
+ | |Index || class(PlotObjects)|| This contains data read from the "GIS Plot Objects" | ||
+ | |- | ||
+ | |nodes|| class(NodeInfo) || Contains information on the 1D nodes, as read from the "1D Node Info" .csv file. | ||
+ | |- | ||
+ | |Channels|| class(ChanInfo)|| Contains information on the 1D nodes, as read from the "1D Channel Info" .csv file. | ||
+ | |- | ||
+ | |times || numpy ndarray|| The active times. This is typically static, however calls to function '''getTS''' may cause this array to be updated (if the 1D or 2D outputs have a different output interval) | ||
+ | |} | ||
+ | <br> | ||
=Examples= | =Examples= | ||
+ | These examples can be downloaded in .py format along with the example results from the TUFLOW website (link required). | ||
<pre> | <pre> | ||
import os #operating system functions | import os #operating system functions |
Revision as of 09:13, 15 March 2016
Currently Under Construction
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:
- Combines the 1D results, 2D plot outputs and new reporting location data
- The outputs are stored in a separate Plot folder in the TUFLOW results directory
- .tpc (TUFLOW Plot Control file links to data in csv and gis folders
- Has additional Node and Channel information files contain connectivity information
This is the default approach for the 2016 version but can be modified with the TUFLOW command "Output Approach == Pre 2016" (refer to the manual for more information on this command.
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.
Dependencies
The TUFLOW results library calls a number of python libraries, these are:
- csv
- numpy
- os
- 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/.
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.
Usage
Import
This library is imported with the typical python syntax.
import TUFLOW_results2016
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:
res = TUFLOW_results2016.ResData()
Defined Methods (Functions)
The following are the defined functions in the results data class (ResData).
Load Results
Results are loaded in with the syntax below.
error, message = res.Load(r'D:\TUFLOW\QGIS\test\plot\Plot_Example.tpc')
The two return arguments are:
- error (logical) set to True if an error has been encountered.
- message (string), if an error has occurred the message string will be populated with an error message.
Get Time-series
Time-series at a 1D, 2D or reporting location can be returned using the following syntax:
found, results, message = res.getTSData(<ID>,<domain>,<results type>,<geometry>)
The inputs to this are:
The return arguments are:
For example:
found, results, message = res.getTS('ds3','1D','Q','L')
Will return flow (Q) data for the 1D channel with ID ds3. The optional 'L' geometry indicates that this is stored on a line object in the GIS plot objects. Note As the time data typically does not change (this is not a return argument) but can be accessed by the res.times. See the examples below.
Long Profile Functions
When dealing with 1D long profile data, if a single 1D channel is specified the data for all channels downstream will returned. If two channels are specified, long profile data will only be returned for the channels between the specified channels.
Get Long Profile Connectivity (LP_getConnectivity)
This determines and stores the connectivity of the specified channels. This is used in later routines to determine the channels and nodes to plot for the long profile. The syntax is:
error, message = res.LP_getConnectivity(<US Channel ID>,<US Channel ID or None>)
The inputs to this are:
The return arguments are:
error, message = res.LP_getConnectivity('FC01.40',None)
Determines all the channels downstream of FC01.40.
error, message = res.LP_getConnectivity('FC01.40','ds3')
Determines the channels between FC01.40 and ds3, an error will be returned if these channels are not connected.
Get Long Profile Static Data (LP_getStaticData)
Once the connectivity between two channels has been determined, this routine can be used to get data that does not change between time-steps. This includes:
- distance information
- maximum data
- bed levels
The syntax is:
error, message = res.LP_getStaticData()
There are no input arguments as the channel connectivity is stored in the res.LP class. The return arguments are:
Get Long Profile Data (LP_getData)
This function gets data at a specific time. If looping through timesteps (e.g. for an animation) the channel connectivity and static data will not change between timesteps and therefore only the LP_getData will need to be repeated. The syntax is:
error, message = res.LP_getData(<data type>,<time>,<time search tolerance>)
The inputs to this are:
The return arguments are:
error, message = res.LP_getData('Head',1,0.01)
Returns the water level (head) data at time 1 hours using a search tolerance of 0.01 hours.
Other Attributes
Once initialised the ResData class also has a number of attributes associated with it as well as the defined functions described above, these are outlined in the table below.
Attribute Name | Type | Description |
---|---|---|
script_version | string | Contains a version number of the TUFLOW results library, e.g. '2016-01-AA' |
filename | string | The full filepath to the .tpc file. |
fpath | string | The path of the folder which contains the .tpc file. |
nTypes | integer | The number of data types that are stored in the dataset. |
Types | list | A lists of the data types that are stored in the dataset. |
LP | class (LP) | Contains Long profile information, connectivity, distances etc. |
Data_1D | class(Data_1D) | The 1D results are all stored in this class. |
Data_2D | class(Data_2D) | The 2D results are all stored in this class. |
Data_RL | class(Data_RL) | The reporting location results are all stored in this class. |
GIS | class(GIS) | This contains the information read in from the GIS Plot Layer csv files. |
formatVersion | integer | The format version of the results as defined in the .tpc file. |
units | string | The units as defined in the .tpc. E.g. "Metric" or "English" |
displayname | string | The simulation name e.g. "M04_5m_001_2015" |
Index | class(PlotObjects) | This contains data read from the "GIS Plot Objects" |
nodes | class(NodeInfo) | Contains information on the 1D nodes, as read from the "1D Node Info" .csv file. |
Channels | class(ChanInfo) | Contains information on the 1D nodes, as read from the "1D Channel Info" .csv file. |
times | numpy ndarray | The active times. This is typically static, however calls to function getTS may cause this array to be updated (if the 1D or 2D outputs have a different output interval) |
Examples
These examples can be downloaded in .py format along with the example results from the TUFLOW website (link required).
import os #operating system functions import sys #system functions import matplotlib.pyplot as plt import TUFLOW_results2016 res = TUFLOW_results2015.ResData() error, message = res.Load(input_res) if error: print(message) sys.exit() print('loaded')
Other Versions
An older version that is compatible with results from the 2013 version of TUFLOW (this is limited to the 1D results for this version). This is currently undocumented, however, if you would like this please contact support@tuflow.com.