Difference between revisions of "XPSWMM Conversion TUFLOW Structure"
Jump to navigation
Jump to search
Chris Huxley (talk | contribs) |
|||
| (18 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = Convert XPSWMM Model to Recommended TUFLOW Structure = | |
| − | When XPSWMM writes its TUFLOW files, it consolidates all the information into a single folder | + | When XPSWMM writes its TUFLOW files, it consolidates all the information into a single folder, typically the '''2D\Data''' folder. This is not the standard TUFLOW structure. The standard structure used by the majority of TUFLOW modelers globally includes the following subfolders: |
{| class="wikitable" width="80%" style="text-align:center" | {| class="wikitable" width="80%" style="text-align:center" | ||
| − | !style="background-color:#005581; font-weight:bold; color:white;"| | + | !style="background-color:#005581; font-weight:bold; color:white;"| |
!style="background-color:#005581; font-weight:bold; color:white;"| Folder | !style="background-color:#005581; font-weight:bold; color:white;"| Folder | ||
!style="background-color:#005581; font-weight:bold; color:white;"| Folder Purpose | !style="background-color:#005581; font-weight:bold; color:white;"| Folder Purpose | ||
|- | |- | ||
| − | |rowspan="10"|[[File:TUFLOW_Folder_Structure.JPG | + | |rowspan="10"|[[File:TUFLOW_Folder_Structure.JPG]] |
|- | |- | ||
|colspan="2"|'''Folders typically saved to the network within a folder titled TUFLOW''' | |colspan="2"|'''Folders typically saved to the network within a folder titled TUFLOW''' | ||
| Line 30: | Line 30: | ||
<br> | <br> | ||
| − | To simplify the process of converting the XPSWMM model to the recommended TUFLOW SWMM folder structure, we have | + | To simplify the process of converting the XPSWMM model to the recommended TUFLOW SWMM folder structure, we have developed a processing tool. This tool converts the GIS format written by XPSWMM (mif/mid) into a more user friendly GeoPackage Database format, creates the recommended TUFLOW folder structure, and saves the converted model files to their correct locations. |
| + | |||
| + | For more information on the processing tool, see <u>[[Convert_TUFLOW_Model_GIS_Format | Convert TUFLOW Model GIS Format]]</u>. | ||
<ol> | <ol> | ||
| Line 37: | Line 39: | ||
:*Install the QGIS TUFLOW Plugin by following the instructions, <u>[[TUFLOW_QGIS_Plugin | QGIS TUFLOW Plugin Installation]]</u>. | :*Install the QGIS TUFLOW Plugin by following the instructions, <u>[[TUFLOW_QGIS_Plugin | QGIS TUFLOW Plugin Installation]]</u>. | ||
<li> In QGIS, go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox. | <li> In QGIS, go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox. | ||
| − | <li> Go to 'TUFLOW' in the processing tool list and select ' | + | <li> Go to 'TUFLOW' in the processing tool list and select 'Convert TUFLOW Model GIS Format'. This opens the dialog shown below. |
:* TCF: Click '...' and navigate to the XPSWMM .tcf. This should be located in the '''2D\Data''' folder. | :* TCF: Click '...' and navigate to the XPSWMM .tcf. This should be located in the '''2D\Data''' folder. | ||
:* Output Vector Format: 'GPKG' | :* Output Vector Format: 'GPKG' | ||
| Line 45: | Line 47: | ||
:* Advanced Parameters: | :* Advanced Parameters: | ||
::* Tick on 'Write empty files'. | ::* Tick on 'Write empty files'. | ||
| − | ::* Output CRS: Select an appropriate Coordinate Reference System (CRS) for the model. | + | ::* Output CRS: Select an appropriate Coordinate Reference System (CRS) for the model. For the demonstration model, the CRS is 'EPSG:32760 - WGS 84 / UTM zone 60S'. |
::* Tick on 'Force TUFLOW Directory Structure'. | ::* Tick on 'Force TUFLOW Directory Structure'. | ||
| − | ::* TUFLOW Directory Structure Settings: Click '...'. Under 'Folder Structure', click the [[File: convert_model_GIS_plus_icon_01a.png | 30px]] icon to add a folder. Set 'Key' to '''swmm''', and 'Path' to '''./model/swmm'''. | + | ::* TUFLOW Directory Structure Settings: Click '...'. Under 'Folder Structure', click the [[File: convert_model_GIS_plus_icon_01a.png | 30px]] icon to add a folder. Set 'Key' to '''swmm''', and 'Path' to '''./model/swmm'''. Tick on this new '''swmm''' folder. |
<li> Click 'Run'. Once the tool is finished, click 'Close'. | <li> Click 'Run'. Once the tool is finished, click 'Close'. | ||
<br><br> | <br><br> | ||
| − | {{Video|name= | + | {{Video|name=Animation_XPtoTUFLOW_2D_model_03d.mp4|width=1350}} |
<br> | <br> | ||
| − | <li> Inspect the tool output to familiarize yourself with the TUFLOW model structure. | + | <li> Inspect the tool output to familiarize yourself with the TUFLOW model folder and file structure. |
<br><br> | <br><br> | ||
| − | {{Video|name=|width=1350}} | + | {{Video|name=Animation_XPtoTUFLOW_2D_model_04d.mp4|width=1350}} |
<br> | <br> | ||
</ol> | </ol> | ||
| − | |||
{{Tips Navigation | {{Tips Navigation | ||
| − | |uplink=[[XPSWMM_to_TUFLOW-SWMM#Two_Dimensional_(2D)_Model_Elements| Back to XPSWMM to TUFLOW Conversion Page]] | + | |uplink=[[XPSWMM_Conversion_Load_TUFLOW_Model| Continue to Next Step: "Load TUFLOW Model in QGIS"]] |
| + | }} | ||
| + | {{Tips Navigation | ||
| + | |uplink=[[XPSWMM_to_TUFLOW-SWMM#Two_Dimensional_(2D)_Model_Elements| Back to Main XPSWMM to TUFLOW Conversion Page]] | ||
}} | }} | ||
Latest revision as of 09:51, 20 August 2024
Convert XPSWMM Model to Recommended TUFLOW Structure
When XPSWMM writes its TUFLOW files, it consolidates all the information into a single folder, typically the 2D\Data folder. This is not the standard TUFLOW structure. The standard structure used by the majority of TUFLOW modelers globally includes the following subfolders:
| Folder | Folder Purpose | |
|---|---|---|
| ||
| Folders typically saved to the network within a folder titled TUFLOW | ||
| runs | TUFLOW Control File(s) (.tcf), the primary file(s) used to run TUFLOW simulations, are saved here. | |
| runs\log | TUFLOW simulation log and error/warning message files are written here during a model simulation. | |
| bc_dbase | Input boundary condition database(s) and time-series data for 1D and 2D domains are saved here. | |
| model | TUFLOW's second level control files (.tgc, .tbc, .tscf, .ecf) are saved here. | |
| model\gis model\grid model\mi model\swmm |
GIS layers defining the input spatial datasets are saved here. | |
| Folders typically saved to a computers local drive in a Project folder | ||
| results | TUFLOW simulation results are written here during a model simulation. | |
| check | TUFLOW simulation check files are written here during a model simulation. | |
To simplify the process of converting the XPSWMM model to the recommended TUFLOW SWMM folder structure, we have developed a processing tool. This tool converts the GIS format written by XPSWMM (mif/mid) into a more user friendly GeoPackage Database format, creates the recommended TUFLOW folder structure, and saves the converted model files to their correct locations.
For more information on the processing tool, see Convert TUFLOW Model GIS Format.
- Open QGIS. If you do not have QGIS installed:
- Install QGIS 3.34 or later: Latest 64-bit version of QGIS.
- Install the QGIS TUFLOW Plugin by following the instructions, QGIS TUFLOW Plugin Installation.
- In QGIS, go to Processing > Toolbox from the top dropdown menu options to open the Processing Toolbox.
- Go to 'TUFLOW' in the processing tool list and select 'Convert TUFLOW Model GIS Format'. This opens the dialog shown below.
- TCF: Click '...' and navigate to the XPSWMM .tcf. This should be located in the 2D\Data folder.
- Output Vector Format: 'GPKG'
- Output Raster Format: 'GTIFF'
- Output Profile: Any option can be used. 'ALL IN ONE' is used in this example for model design consistency with the TUFLOW SWMM Tutorials.
- Output Folder: Click '...' and navigate to an appropriate location to save your TUFLOW model. In this location, create a new folder called TUFLOW and select it.
- Advanced Parameters:
- Tick on 'Write empty files'.
- Output CRS: Select an appropriate Coordinate Reference System (CRS) for the model. For the demonstration model, the CRS is 'EPSG:32760 - WGS 84 / UTM zone 60S'.
- Tick on 'Force TUFLOW Directory Structure'.
- TUFLOW Directory Structure Settings: Click '...'. Under 'Folder Structure', click the
icon to add a folder. Set 'Key' to swmm, and 'Path' to ./model/swmm. Tick on this new swmm folder.
- Click 'Run'. Once the tool is finished, click 'Close'.
- Inspect the tool output to familiarize yourself with the TUFLOW model folder and file structure.
| Up |
|---|
 Continue to Next Step: "Load TUFLOW Model in QGIS"
|
| Up |
|---|
| Back to Main XPSWMM to TUFLOW Conversion Page
|