Convert to TS1: Difference between revisions

Content deleted Content added
 
(10 intermediate revisions by 4 users not shown)
Line 1:
=Introduction=
'''convert_to_ts1.exe''' converts output from hydrologic models to the .ts1 format recognised by TUFLOW. The .ts1 format is a .csv format,file butthat it containsincludes indexing and header information that, significantly reducesreducing the time required for TUFLOW to read the inflow hydrographs into TUFLOW. If there are numerous inflow hydrographs are present, ituse of this format is strongly recommended to use this format.<br>
 
Any number of input files (of the same format) can be specified, and wildcards (ege.g. “*.out”) canmay be used to specifyselect a group of files. The options available options are described in the Tabletable below. One input format switch and one output format switch should be specified. However, although the default output format isdefaults to ts1, so this flag canmay be optionally omitted.<br>
For most options, an additional file “_peak_Q.csv” is output providing a summary of the peak flows for each hydrograph. If a group of files is specified, the _peak_Q.csv file is a summary of all files within the group and a second file “_peak_F.csv” contains which file caused the peak flow of all the files. This is useful for determining which storm duration produced the peak flow or is the critical duration event.<br>
 
At present the program supports the hydrology models most commonly used within Australia. Other formats can be built in through supplying example files/formats and any other useful information to <font color="blue"><u>support@tuflow.com</u></font>.<br>
For most options, an additional file “_peak_Q.csv” is outputproduced, providing a summary ofsummarising the peak flows for each hydrograph. If a group of files is specified, the _peak_Q.csv file is a summary ofsummarises all files within the group, and a second file “_peak_F.csv” containsidentifies which file causedproduced the peak flow ofacross all the files. This is useful for determining which storm duration produced the peak flow or is(i.e. the critical duration event).<br>
The .ts1 file format is outlined in the following page: [[TS1_File_Format | TS1 File Format]].<br>
 
AtThe presentprogram the programcurrently supports the hydrology models most commonly used within Australia. OtherAdditional formats can be builtincorporated in throughby supplying example files/formats and any other usefulrelevant information to <font[mailto:support@tuflow.com color="blue"><u>support@tuflow.com</u></font>].<br>
 
The .ts1 file format is outlined inon the following page: [[TS1_File_Format | TS1 File Format]].<br>
 
=Options=
'''TABLE 1: convert_to_ts1 Options (Switches)'''
Line 20 ⟶ 25:
|"-rows"|| The inflow hydrographs are in space or comma delimited files with the data in blocks of one or more rows for each hydrograph. No time data exists in the input files.
|-
|"-urbs"|| Input files are URBS .q files, which must use relative time in hours from the start of the hydrograph.
|-
|"-wbnm"|| Input files are WBNM _Meta.out files.<br>Only outputs in the .ts1 format. Two files are created:
Only outputs in the .ts1 format. Two files are created:<br>
*loc_.ts1 containing the local hydrographs.
*tot_.ts1 containing the total hydrographs.
Line 40 ⟶ 44:
|-
|-
|"-mr event_names.txt"|| Multiple Rafts Durations: Read multiple durations from a rafts *.loc or *.tot file. Must be used in conjunction with the -rafts switch. Event namesEvents are read directly from the *.out file. Names of each event are extracted from the text file event_names.txt (refer example below). The order of the durations in event_names.txt has to be the same as the order of ticked durations in XPRAFTS. Please note: Routing increments must be the same for all storm durations. Multiple file processing using the * wildcard feature not yet supported with the -mr switch enabled.
|-
!colspan="2" style="background-color:#005581; font-weight:bold; color:white;"| Miscellaneous Switches
Line 56 ⟶ 60:
 
=Examples=
<ol>
<tt>convert_to_ts1.exe -wbnm -ts1 Q100_Meta.out</tt><br>
outputs<li>Outputs two .ts1 files, one the local hydrographs and the other for the total hydrographs in Q100_Meta.out.<br>
<tt>convert_to_ts1.exe -wbnm -ts1 Q100_Meta.out</tt><br>
 
outputs<li>Outputs .ts1 files for every .out file in the folder. A summary of the peak flows can be found in the _peak_Q.csv and _peak_F.csv files.<br>
<tt>convert_to_ts1.exe -rorb -ts1 -dt5 *.out</tt><br>
outputs .ts1 files for every .out file in the folder. A summary of the peak flows can be found in the _peak_Q.csv and _peak_F.csv files.<br>
<li>Outputs .ts1 from .int file.<br>
 
<tt>convert_to_ts1.exe -raftsxp -ts1 Q100*.loc Q100*.totint</tt><br>
outputs<li>Outputs .ts1 files for every Q100 .loc and .tot file in the folder. A summary of the peak flows can be found in the _peak_Q.csv and _peak_F.csv files.<br>
<tt>convert_to_ts1.exe -rafts -csvts1 Q100*.totloc Q050Q100*.tot Q100.loc Q050.loc</tt><br>
 
outputs<li>Outputs .csv files for the four files specified. The output time is in hours. <br>
<tt>convert_to_ts1.exe -rafts -csv Q100.tot Q050.tot Q100.loc Q050.loc</tt><br>
<tt>convert_to_ts1.exe -rafts -csv -thour Q100.tot Q050.tot Q100.loc Q050.loc</tt>
outputs .csv files for the four files specified.<br>
outputs<li>Outputs a separate .csv file for each duration specified within event_names.txt and the result my_results.tot. The order thatof youthe populatedurations eventsin event_names.txt is important withand has to be the conventionsame as the order of ticked durations in XPRAFTS. Example is shown below. <br>
 
<tt>convert_to_ts1.exe -rafts -mr event_names.txt -e0 -csv my_results.tot</tt><br>
<br>
outputs a separate .csv file for each duration specified within event_names.txt and the result my_results.tot. The order that you populate events.txt is important with the convention shown below. <br>
[[File:RAFTS Storm Control.png | 500px]]<br>
 
<br>
outputs<li>Outputs a separate .csv file for each event within the wbnm output file Q100.out.<br>
<tt>convert_to_ts1.exe -wbnm -mw -csv Q100.out</tt><br>
<br>
outputs a separate .csv file for each event within the wbnm output file Q100.out.<br>
</ol>
 
{{Tips Navigation