Difference between revisions of "Convert to TS1"
(Created page with "=Introduction= =Examples= {{Tips Navigation |uplink= Back to TUFLOW Utilities }}") |
|||
| Line 1: | Line 1: | ||
=Introduction= | =Introduction= | ||
| + | '''convert_to_ts1.exe''' converts output from hydrologic models to the .ts1 format recognised by TUFLOW. The .ts1 format is a .csv format, but it contains indexing and header information that significantly reduces the time to read the inflow hydrographs into TUFLOW. If there are numerous inflow hydrographs, it is strongly recommended to use this format.<br> | ||
| + | Any number of input files (of the same format) can be specified and wildcards (eg. “*.out”) can be used to specify a group of files. The options available are described in the Table below. One input format and one output format switch should be specified, although the default output format is ts1, so this flag can 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 support@tuflow.com.<br> | ||
| + | =Options= | ||
| + | '''TABLE 1: convert_to_ts1 Options (Switches)''' | ||
| + | {| align="center" class="wikitable" | ||
| + | ! Switch | ||
| + | ! width=85% | Description | ||
| + | |- | ||
| + | !colspan="2" style="background-color:#005581; font-weight:bold; color:white;"| Input File Format Switches | ||
| + | |- | ||
| + | |"-rafts"|| Input files are XP-RAFTS .tot and .loc files. | ||
| + | |- | ||
| + | |"-rorb"|| Input files are RORB .out files. The dt option must also be specified. | ||
| + | |- | ||
| + | |"-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. | ||
| + | |- | ||
| + | |"-wbnm"|| Input files are WBNM _Meta.out files.<br> | ||
| + | Only outputs in the .ts1 format. Two files are created:<br> | ||
| + | *loc_.ts1 containing the local hydrographs. | ||
| + | *tot_.ts1 containing the total hydrographs. | ||
| + | |- | ||
| + | |"-xp"|| Input files are XP-SWMM .int or .ext files. | ||
| + | |- | ||
| + | !colspan="2" style="background-color:#005581; font-weight:bold; color:white;"| Output File Format Switches | ||
| + | |- | ||
| + | |"-csv"|| Output file(s) in .csv format. | ||
| + | |- | ||
| + | |"-ts1"|| Output file(s) in .ts1 format (the default). | ||
| + | |- | ||
| + | !colspan="2" style="background-color:#005581; font-weight:bold; color:white;"| Miscellaneous Switches | ||
| + | |- | ||
| + | |"-b"|| Batch mode. Suppresses prompt to press Enter at end of processing. Used in .bat files where two or more files are to be processed in succession. | ||
| + | |- | ||
| + | |<nowiki>"-dt<dt>"</nowiki>|| Time increment of RORB hydrographs in minutes. For example, 5 minutes would be specified as dt5. | ||
| + | |- | ||
| + | |"-s0"|| Insert a zero flow before the start of the hydrograph. | ||
| + | |- | ||
| + | |"-e0"|| Insert a zero flow after the end of the hydrograph. | ||
| + | |} | ||
=Examples= | =Examples= | ||
{{Tips Navigation | {{Tips Navigation | ||
|uplink=[[TUFLOW_Utilities | Back to TUFLOW Utilities]] | |uplink=[[TUFLOW_Utilities | Back to TUFLOW Utilities]] | ||
}} | }} | ||
Revision as of 13:19, 12 September 2011
Introduction
convert_to_ts1.exe converts output from hydrologic models to the .ts1 format recognised by TUFLOW. The .ts1 format is a .csv format, but it contains indexing and header information that significantly reduces the time to read the inflow hydrographs into TUFLOW. If there are numerous inflow hydrographs, it is strongly recommended to use this format.
Any number of input files (of the same format) can be specified and wildcards (eg. “*.out”) can be used to specify a group of files. The options available are described in the Table below. One input format and one output format switch should be specified, although the default output format is ts1, so this flag can be optionally omitted.
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.
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 support@tuflow.com.
Options
TABLE 1: convert_to_ts1 Options (Switches)
| Switch | Description |
|---|---|
| Input File Format Switches | |
| "-rafts" | Input files are XP-RAFTS .tot and .loc files. |
| "-rorb" | Input files are RORB .out files. The dt option must also be specified. |
| "-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. |
| "-wbnm" | Input files are WBNM _Meta.out files. Only outputs in the .ts1 format. Two files are created:
|
| "-xp" | Input files are XP-SWMM .int or .ext files. |
| Output File Format Switches | |
| "-csv" | Output file(s) in .csv format. |
| "-ts1" | Output file(s) in .ts1 format (the default). |
| Miscellaneous Switches | |
| "-b" | Batch mode. Suppresses prompt to press Enter at end of processing. Used in .bat files where two or more files are to be processed in succession. |
| "-dt<dt>" | Time increment of RORB hydrographs in minutes. For example, 5 minutes would be specified as dt5. |
| "-s0" | Insert a zero flow before the start of the hydrograph. |
| "-e0" | Insert a zero flow after the end of the hydrograph. |
Examples
| Up |
|---|
 Back to TUFLOW Utilities
|