Difference between revisions of "QGIS SWMM Convert XPSWMM Model From XPX"

From Tuflow
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
The tool uses the <u>[[Convert_TUFLOW_Model_GIS_Format |Convert TUFLOW Model GIS Format]]</u> processing tool to convert the 2D portion of the model, extracts the 1D portion from the xpx file, and modifies the converted model to incorporate SWMM into the TUFLOW model.  
 
The tool uses the <u>[[Convert_TUFLOW_Model_GIS_Format |Convert TUFLOW Model GIS Format]]</u> processing tool to convert the 2D portion of the model, extracts the 1D portion from the xpx file, and modifies the converted model to incorporate SWMM into the TUFLOW model.  
  
−
'''Please refer to <u>[[XPSWMM_to_TUFLOW-SWMM |XPSWMM to TUFLOW SWMM ]]</u>, for further instructions on the model conversion process. '''
+
'''Please refer to <u>[[XPSWMM_to_TUFLOW-SWMM |XPSWMM to TUFLOW SWMM]]</u>, for further instructions on the model conversion process. '''
  
 
To export the xpx file from XPSWMM:
 
To export the xpx file from XPSWMM:
Line 15: Line 15:
  
 
== Usage ==
 
== Usage ==
−
This tool, '''Convert - XPSWMM model from XPX (beta)''', can be found in the QGIS processing toolbox panel under TUFLOW >> SWMM. To open the Processing Toolbox panel, navigate to 'Processing' in the menubar and select 'Toolbox'.<br>
+
This tool, '''Convert - XPSWMM model from XPX''', can be found in the QGIS processing toolbox panel under TUFLOW >> SWMM. To open the Processing Toolbox panel, navigate to 'Processing' in the menubar and select 'Toolbox'.<br>
 
<br>
 
<br>
 
[[File:open_processing_toolbox.png]]<br>
 
[[File:open_processing_toolbox.png]]<br>
Line 22: Line 22:
 
=== Parameters ===
 
=== Parameters ===
 
<ol>
 
<ol>
−
<li>'''XPSWMM Exported XPX File:''' Click '...' and navigate to the exported XPX data. This should be located in the same folder as the XPSWMM model.  
+
<li>'''XPSWMM Exported XPX File:''' The *.xpx file exported from the XPSWMM application or viewer.  
−
<li>'''TUFLOW TCF Filename: Click '...' and navigate to the XPSWMM .tcf. This should be located in the '''2D\Data''' folder.  
+
<li>'''TUFLOW TCF Filename:''' The TUFLOW control file (TCF) from the XPSWMM model. By default, this will be located in the '''2D\Data''' folder.
−
<li>'''SWMM File Prefix: Choose an appropriate prefix for the SWMM files (e.g. '''Urban''').
+
<li>'''SWMM File Prefix:''' Sets the prefix for the SWMM files in the converted model.
−
<li>'''Output Solution Scheme: 'HPC'
+
<li>'''Output Solution Scheme:''' The solution scheme for the converted model.
−
<li>'''Output Hardware Specification: 'GPU' (if GPU is not available, select 'CPU')
+
<li>'''Output Hardware Specification:''' The hardware selection for the converted model
−
<li>'''Output Vector Format: 'GPKG'
+
<li>'''Output Vector Format:''' The GIS format to use for the converted TUFLOW files.
−
<li>'''Output Raster Format: 'GTIFF'
+
<li>'''Output Raster Format:''' The raster format used for the DEMs in the converted model.
−
<li>'''Output Profile: Any option can be used. 'ALL IN ONE' is used in this example for model design consistency with the <u>[[Tutorial_Introduction | TUFLOW SWMM Tutorials]]</u>.
+
<li>'''Output Profile:''' The format of the output TUFLOW GIS files.  
−
<li>'''Event name if no global storms: If no global storms, leave as default. Otherwise, choose an appropriate event name.  
+
<li>'''Event name if no global storms:''' Event name for converted TUFLOW files.  
−
<li>'''BC width for created 1D/2D connections (HX/SX): This value should be approximately 2 times the width of the hydraulic model 2D cell size.
+
<li>'''BC width for created 1D/2D connections (HX/SX):''' Width of 1D/2D connections. This value should be approximately 2 times the width of the hydraulic model 2D cell size.
−
<li>'''BC offset distance for created 1D/2D connections (HX/SX): Distance from the channel endpoint to the midpoint of the BC line.
+
<li>'''BC offset distance for created 1D/2D connections (HX/SX):''' Distance from the channel endpoint to the midpoint of the BC line.
−
<li>'''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.
+
<li>'''Output Folder:''' Determines the location of the converted model. To ensure correct TUFLOW-SWMM model folder structure, navigate to an appropriate file location, create a '''TUFLOW''' folder and select it.  
−
<li>'''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'.
+
<li>'''Output CRS:''' The CRS (Coordinate Reference System) for the TUFLOW-SWMM model. The tool will apply this CRS to the output files..
 
</ol>
 
</ol>
 
<br>
 
<br>
−
[[File: Convert_XPSWMM_Hydrology_Dialog_a.png]]
+
[[File: Convert_XPSWMM_Model_From_XPX_Dialog.png]]
 +
<br>
  
−
== Example ==
 
−
<br>
 
−
{{Video|name=.mp4|width=1236}}
 
−
<br>
 
  
 
{{Tips Navigation
 
{{Tips Navigation
 
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
 
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
 
}}
 
}}

Latest revision as of 13:10, 20 August 2024

Introduction

This tool converts XPSWMM models for use in TUFLOW-SWMM using a xpx file exported from XPSWMM. Common XPSWMM parameters are converted. Some attributes will need to be specified manually. The tool uses the Convert TUFLOW Model GIS Format processing tool to convert the 2D portion of the model, extracts the 1D portion from the xpx file, and modifies the converted model to incorporate SWMM into the TUFLOW model.

Please refer to XPSWMM to TUFLOW SWMM, for further instructions on the model conversion process.

To export the xpx file from XPSWMM:

  1. From the top dropdown menu options, select File > Import/Export Data > Export XPX Data. This will open a dialog. Leave all options as default and click 'Export'.
  2. When prompted, save the file under an appropriate name to the folder where the XPSWMM model is located.

Note: The xpx file can be exported from XPSWMM or the free XPSWMM Viewer.

Usage

This tool, Convert - XPSWMM model from XPX, can be found in the QGIS processing toolbox panel under TUFLOW >> SWMM. To open the Processing Toolbox panel, navigate to 'Processing' in the menubar and select 'Toolbox'.

Open processing toolbox.png

Parameters

  1. XPSWMM Exported XPX File: The *.xpx file exported from the XPSWMM application or viewer.
  2. TUFLOW TCF Filename: The TUFLOW control file (TCF) from the XPSWMM model. By default, this will be located in the 2D\Data folder.
  3. SWMM File Prefix: Sets the prefix for the SWMM files in the converted model.
  4. Output Solution Scheme: The solution scheme for the converted model.
  5. Output Hardware Specification: The hardware selection for the converted model
  6. Output Vector Format: The GIS format to use for the converted TUFLOW files.
  7. Output Raster Format: The raster format used for the DEMs in the converted model.
  8. Output Profile: The format of the output TUFLOW GIS files.
  9. Event name if no global storms: Event name for converted TUFLOW files.
  10. BC width for created 1D/2D connections (HX/SX): Width of 1D/2D connections. This value should be approximately 2 times the width of the hydraulic model 2D cell size.
  11. BC offset distance for created 1D/2D connections (HX/SX): Distance from the channel endpoint to the midpoint of the BC line.
  12. Output Folder: Determines the location of the converted model. To ensure correct TUFLOW-SWMM model folder structure, navigate to an appropriate file location, create a TUFLOW folder and select it.
  13. Output CRS: The CRS (Coordinate Reference System) for the TUFLOW-SWMM model. The tool will apply this CRS to the output files..


Convert XPSWMM Model From XPX Dialog.png


Up
Go-up.png Back to TUFLOW QGIS Plugin Main Page
Retrieved from "https://wiki.tuflow.com/w/index.php?title=QGIS_SWMM_Convert_XPSWMM_Model_From_XPX&oldid=40566"