Difference between revisions of "XPSWMM Conversion TUFLOW Control File Formatting"

From Tuflow
Jump to navigation Jump to search
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Format TUFLOW Control Files (Optional) ==
 
== Format TUFLOW Control Files (Optional) ==
−
In the previous sections, we removed unnecessary commands from the TUFLOW Control Files and introduced additional commands to ensure the TUFLOW SWMM model runs smoothly. In this section, we will format and organize the TUFLOW control files to enhance readability, thereby improving the overall functionality of the model. This can be done by:
+
In the previous sections, we removed unnecessary commands from the TUFLOW Control Files and introduced additional commands to ensure the TUFLOW SWMM model runs smoothly. While this is sufficient to run your model, it is recommended to format and organize the TUFLOW control files to enhance readability. This can be done by:
 
<ol>
 
<ol>
 
<li> Including a title at the beginning of each control file. For example:<br>  
 
<li> Including a title at the beginning of each control file. For example:<br>  
 
<font color="green"><tt>! Project: XYZ</tt></font>.<br>
 
<font color="green"><tt>! Project: XYZ</tt></font>.<br>
 
<font color="green"><tt>! Author: Jane Smith</tt></font>  
 
<font color="green"><tt>! Author: Jane Smith</tt></font>  
−
<li> Adding headings to organize commands into sub-sections. For example:<br>
+
<li> Sorting commands into sub-sections that have a general common purpose, and adding headings above these sub-sections. Below are some example sub-sections TCF headings:<br>
 
<font color="green"><tt>! MODEL INITIALIZATION</tt></font><br>
 
<font color="green"><tt>! MODEL INITIALIZATION</tt></font><br>
 
<font color="green"><tt>! SOLUTION SCHEME</tt></font><br>
 
<font color="green"><tt>! SOLUTION SCHEME</tt></font><br>
Line 13: Line 13:
 
<font color="green"><tt>! OUTPUT SETTINGS</tt></font><br>
 
<font color="green"><tt>! OUTPUT SETTINGS</tt></font><br>
 
<li> Utilizing comments to explain the purpose of commands. For example: <br>
 
<li> Utilizing comments to explain the purpose of commands. For example: <br>
−
<font color="blue"><tt>GIS Format == </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> GPKG </tt></font> <font color="green"><tt>  ! Specify GPKG as the output format for all GIS files</tt></font>.
+
<font color="blue"><tt>GIS Format </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> GPKG </tt></font> <font color="green"><tt>  ! Specify GPKG as the output format for all GIS files</tt></font>.
 
</ol>
 
</ol>
−
If using the provided model conversion dataset, after formatting, the final TUFLOW Control File may look like this:<br>
 
−
'''<font color="red"> insert images when dataset finalised </font>'''
 
−
<br>
 
  
 +
The image below shows the TCF from the provided model dataset after it has been organized and formatted.
 +
<br><br>
 +
[[File:XPSWMM_to_TUFLOW_clean_TCF_01c.png]]
 +
<br><br>
  
 +
 +
{{Tips Navigation
 +
|uplink=[[XPSWMM_to_TUFLOW-SWMM#TUFLOW_Simulation_Execution| Continue to Next Step: "TUFLOW Simulation Execution"]]
 +
}}
 
{{Tips Navigation
 
{{Tips Navigation
−
|uplink=[[XPSWMM_to_TUFLOW-SWMM#TUFLOW_Control_File_Updates| Back to XPSWMM to TUFLOW Conversion Page]]
+
|uplink=[[XPSWMM_to_TUFLOW-SWMM#TUFLOW_Simulation_Execution| Back to Main XPSWMM to TUFLOW Conversion Page]]
 
}}
 
}}

Latest revision as of 14:16, 1 March 2024

Format TUFLOW Control Files (Optional)

In the previous sections, we removed unnecessary commands from the TUFLOW Control Files and introduced additional commands to ensure the TUFLOW SWMM model runs smoothly. While this is sufficient to run your model, it is recommended to format and organize the TUFLOW control files to enhance readability. This can be done by:

  1. Including a title at the beginning of each control file. For example:
    ! Project: XYZ.
    ! Author: Jane Smith
  2. Sorting commands into sub-sections that have a general common purpose, and adding headings above these sub-sections. Below are some example sub-sections TCF headings:
    ! MODEL INITIALIZATION
    ! SOLUTION SCHEME
    ! MODEL INPUTS
    ! TIME CONTROLS
    ! OUTPUT FOLDERS
    ! OUTPUT SETTINGS
  3. Utilizing comments to explain the purpose of commands. For example:
    GIS Format == GPKG ! Specify GPKG as the output format for all GIS files.

The image below shows the TCF from the provided model dataset after it has been organized and formatted.

XPSWMM to TUFLOW clean TCF 01c.png


Up
Go-up.png Continue to Next Step: "TUFLOW Simulation Execution"
Up
Go-up.png Back to Main XPSWMM to TUFLOW Conversion Page
Retrieved from "https://wiki.tuflow.com/w/index.php?title=XPSWMM_Conversion_TUFLOW_Control_File_Formatting&oldid=38856"