XPSWMM to TUFLOW-SWMM: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
 
(13 intermediate revisions by 3 users not shown)
Line 2:
This Wiki page outlines recommended steps for the conversion of an XPSWMM model to TUFLOW. <br>
 
XPSWMM is a flood and urban stormwater drainage modeling software developed by Autodesk (previously Innovyze and XP Solutions). The XPSWMM solution uses EPA SWMM for its 1D calculations, dynamically linked to TUFLOW for its 2D calculations. The software functions within a custom build Graphical User Interface (GUI). Unknown to many XPSWMM modelers, during simulation, XPSWMM processes its inputs into TUFLOW files and also calls TUFLOW for the 2D calculations. As XPSWMM uses TUFLOW for its 2D engine, like-for-like results can be achieved using this software. TUFLOWThe ismodeling theworkflow naturalin replacementTUFLOW fordiffers from XPSWMM, foras peopleTUFLOW whomodeling areis lookingintegrated forwith anQGIS alternative(Geographical solutionInformation followingSystem) Autodesk'sGIS recentsoftware XPSWMMinstead pricing,of licensing,embedded within a software specific andGraphical supportUser changesInterface.
 
Common user feedback suggests the XPSWMM GUI is useful for simple modeling projects; however, it can become cumbersome and workflow inefficient when dealing with larger datasets and/or a large volume of different scenario and event simulations. In response to requests from USA XPSWMM users who want to convert XPSWMM models into a native TUFLOW format, TUFLOW linkage with 1D EPA Storm Water Management Model (SWMM) was added as a supported feature in TUFLOW 2023-03-AD release. The modeling workflow in TUFLOW differs from XPSWMM, as TUFLOW modeling is integrated with QGIS (Geographical Information System) GIS software. This is, however, a net positive. GIS integration is well-suited for working with larger datasets. Additionally, the structural design associated with TUFLOW modeling makes its general workflow extremely efficient, particularly for the automated management of multiple scenarios and events.
 
If you are building a TUFLOW SWMM model from scratch, not from XPSWMM, please refer to the <u>[[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]]</u>. Tutorials are provided for the following topics:
Line 13 ⟶ 11:
 
== Dataset Download ==
The dataset used for this model conversion demonstration is available for download here: <u>[https://downloads.tuflow.com/SWMM/XPSWMM_to_TUFLOW_Model_ConversionXPSWMM_XPX_to_TUFLOW_Conversion.zip XPSWMM XPX to TUFLOW Model Conversion Dataset]</u>. <br>
This dataset contains the XPSWMM model and the resulting TUFLOW model that is created. These can be found in the '''XPSWMM''' and '''Complete_Conversion''' folders respectively. <br>
 
Line 19 ⟶ 17:
 
If you do not have access to a XPSWMM license and the XPSWMM Application, please refer to the <u>[[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Model_Conversion_Without_a_XPSWMM_License |XPSWMM to TUFLOW SWMM Troubleshooting]]</u> page. <br>
 
== TUFLOW Licensing / XPSWMM Discount ==
If you are an existing or past XPSWMM perpetual license owner who would like to purchase a TUFLOW license, please contact <u>[mailto::sales@tuflow.com sales@tuflow.com]</u>. You may be eligible for a XPSWMM / TUFLOW discount in recognition of past royalties Autodesk paid TUFLOW if you previously purchased an XPSWMM perpetual license.
 
= XPSWMM to TUFLOW Model Conversion =
Line 35 ⟶ 30:
<li> Under '2D Hydraulics Job Control', select 'Surface & Sampling'.
<li> Review the options in the 'Surface' section:
:* If 'Use DTM' is selected: Continue to the section below (<u>[[XPSWMM_to_TUFLOW-SWMM_DraftSWMM#Export_DTM_Data_from_XPSWMM |Export DTM Data from XPSWMM]]</u>) and complete the steps.
:* If 'Use Grid File for Topography' is selected and a 'Grid file' is specified, the steps outlined in the 'Export DTM Data From XPSWMM' section can be skipped. Go to the <u>[[XPSWMM_to_TUFLOW-SWMM_DraftSWMM#Export_XPX_Data_From_XPSWMM|Export XPX Data From XPSWMM]]</u> section.
'''Note:''' If you have a .tif elevation file, you can continue to the <u>[[XPSWMM_to_TUFLOW-SWMM_DraftSWMM#Export_XPX_Data_From_XPSWMM|Export XPX Data From XPSWMM]]</u> section. The conversion process will be identical however, once converted, you will have to create the '''TUFLOW\model\grid''' folder manually and copy the .tif file into it.
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Export_Data_01b.mp4|width=1350}}
Line 63 ⟶ 58:
<li> Run the XPSWMM model to rewrite the TUFLOW files (including the new linkage to the DTM dataset) to the Data folder (go to Analyze > Solve... in top dropdown menu options).
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Export_Data_02aAnimation_XPtoTUFLOW_Export_Data_02b.mp4|width=1350}}
<br>
</ol>
Line 73 ⟶ 68:
<li> When prompted, save the file under an appropriate name (eg '''1D2D_Urban_001.xpx''') to the folder where the XPSWMM model is located.
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Export_Data_03aAnimation_XPtoTUFLOW_Export_Data_03b.mp4|width=1350}}
<br>
</ol>
Line 79 ⟶ 74:
== Convert XPSWMM Model to TUFLOW SWMM ==
Ensure you have QGIS and have the QGIS TUFLOW Plugin installed:
*Install QGIS 3.34 or later: <u>[https://www.qgis.org/endownload/site/forusers/download.html Latest 64-bit version of QGIS]</u>.
*Install the QGIS TUFLOW Plugin by following the instructions, <u>[[TUFLOW_QGIS_Plugin | QGIS TUFLOW Plugin Installation]]</u>.
 
Line 102 ⟶ 97:
<li> Click 'Run'. Once the tool is finished, click 'Close'.
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Convert_01bAnimation_XPtoTUFLOW_Convert_01c.mp4|width=1350}}
<br>
</ol>
Line 114 ⟶ 109:
: '''Note:''' Conversion messages are addressed in further detail here <u>[[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Common_Conversion_Issues |XPSWMM to TUFLOW SWMM Troubleshooting]]</u>.
* The '''TUFLOW\runs''' folder contains the TCF. If event(s) are specified, the TCF filename with have event placeholder(s), i.e. '_~e1~_~e2~_' (e.g. '''1D2D_Urban_001_~e1~.tcf'''). Again, if event(s) are used, this folder also contains the TUFLOW Event File (TEF) with the event(s) specified. <br>
{{Video|name=Animation_XPtoTUFLOW_Convert_02aAnimation_XPtoTUFLOW_Convert_02b.mp4|width=800}}
<br>
<li> Open QGIS, and click on the ‘Load TUFLOW Layers from TCF’ symbol from the QGIS TUFLOW Plugin toolbar.
Line 131 ⟶ 126:
<li> Inspect the output GIS layers.
<br><br>
{{Video|name=Animation_XPtoTUFLOW_Convert_03aAnimation_XPtoTUFLOW_Convert_03b.mp4|width=1350}}
<br>
</ol>
Line 145 ⟶ 140:
<li>Create a new text file in the '''TUFLOW\runs''' folder and save as '''_run_HPC.bat'''.
<li>Open the '''_run_HPC.bat''' in a text editor and include a file path to the TUFLOW executable and the TCF name: <br>
<font color="blackblue"><tt>set </font>exe<font color="red">=</font>"..\..\exe\2023-03-AD\TUFLOW_iSP_w64.exe" 1D2D_Urban_001_~e1~.tcf</tt></font> <br>
<font color="blue"><tt>set </font>run<font color="red">=</font>start "TUFLOW" /wait <font color="orange">%exe%</font> -b<br>
<font color="orange">%run%</font> -e1 100yr 1D2D_Urban_001_~e1~.tcf</tt></font></tt> <br>
<br>
'''Note:''' A relative path is used for the executable and the TCF, full file path can also be used.
<li>Save the batch file and double click it in Windows File Explorer to run the simulation. This will open the TUFLOW DOS Console Window and the simulation should be executed.
</ol>
 
Line 157 ⟶ 155:
= TUFLOW SWMM Result Viewing =
Are you familiar with loading and viewing TUFLOW results in QGIS? If not, we strongly recommend self-registering and completing our free eLearning:
<u>[https://www.tuflow.com/training/training-course-catalogue/tt001ett001-e-introduction-to-qgis-for-tuflow-elearning/ Introduction to QGIS for TUFLOW]</u>. <br>
 
Our <u>[[TUFLOW_SWMM_Tutorial_Introduction | TUFLOW SWMM Tutorials]]</u> also demonstrate working with TUFLOW SWMM results.
 
Line 173 ⟶ 172:
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydraulics_Addendum-20220210mas2wr.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics Addendum) ]</u>
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume3_Water_Quality_P100P2NY.pdf SWMM5 Reference Manual - Volume 3 (Water Quality) ]</u>
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_User%27s_Manualswmm-users-manual-version-5.2.pdf EPA SWMM5 User's Manual]</u>
 
=Feedback / Suggestions=
We hope you have found this model conversion page helpful. If you have any feedback or suggestions, please email <u>[mailto::support@tuflow.com support@tuflow.com]</u>.
<br>