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

From Tuflow
Jump to navigation Jump to search
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
=== Optional: Format TUFLOW Control Files ===
+
== Format TUFLOW Control Files (Optional) ==
−
In the sections above, 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:
−
:* Using relative file paths to specify the location of various files and layers in the model.
+
<ol>
−
:* Including a title at the beginning of each control file. For example, <font color="green"><tt>! TUFLOW CONTROL FILE (.TCF) defines the model simulation parameters and directs input from other data sources</tt></font>.
+
<li> Including a title at the beginning of each control file. For example:<br>
−
:* Adding headings to sections of the control file. For example, <font color="green"><tt>! MODEL INITIALIZATION</tt></font> could be used as a header for the commands required to initialize the TUFLOW SWMM model.
+
<font color="green"><tt>! Project: XYZ</tt></font>.<br>
−
:* Utilizing comments to explain the purpose of commands. For example, <font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt> ..\model\gis\1D2D_Urban_001.gpkg </tt></font> <font color="green"><tt> ! Specify the location of the GeoPackage Spatial Database</tt></font>.<br>
+
<font color="green"><tt>! Author: Jane Smith</tt></font>
−
<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>
−
If using the provided model conversion dataset, the final Control files should look like this:<br>
+
<font color="green"><tt>! MODEL INITIALIZATION</tt></font><br>
−
'''<font color="red"> insert images when dataset finalised </font>'''
+
<font color="green"><tt>! SOLUTION SCHEME</tt></font><br>
−
<br>
+
<font color="green"><tt>! MODEL INPUTS</tt></font><br>
 +
<font color="green"><tt>! TIME CONTROLS</tt></font><br>
 +
<font color="green"><tt>! OUTPUT FOLDERS</tt></font><br>
 +
<font color="green"><tt>! OUTPUT SETTINGS</tt></font><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>.
 +
</ol>
  
 +
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 09:40, 20 August 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=40508"