View source for XPSWMM to TUFLOW-SWMM Archive

= Introduction =
This Wiki page outlines manual steps for the conversion of an XPSWMM model to TUFLOW. A more efficient, semi-automated approach is available using XPSWMM XPX files. It is recommended instead of this less workflow efficient method. For information on the semi-automated approach, see <u>[[XPSWMM_to_TUFLOW-SWMM | XPSWMM to TUFLOW SWMM Automated (Recommended) Approach]]</u>. <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. TUFLOW is the natural replacement for XPSWMM for people who are looking for an alternative solution following Autodesk's recent XPSWMM pricing, licensing, and support changes.

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:
* <u>[[TUFLOW SWMM Tutorial M01 | TUFLOW SWMM Module 1]]</u> - 1D SWMM Culverts
* <u>[[TUFLOW SWMM Tutorial M02 | TUFLOW SWMM Module 2]]</u> - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
* <u>[[TUFLOW SWMM Tutorial M03 | TUFLOW SWMM Module 3]]</u> - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
* <u>[[TUFLOW SWMM Tutorial M04 | TUFLOW SWMM Module 4]]</u> - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology: Executing multiple different event simulations from a single model control file.

== Dataset Download ==
The XPSWMM model used for this model conversion demonstration, and the resulting TUFLOW model that is created, are available for download here: <u>[https://downloads.tuflow.com/SWMM/XPSWMM_to_TUFLOW_Model_Conversion.zip XPSWMM to TUFLOW Model Conversion Dataset]</u>. The models are found in the XPSWMM and TUFLOW folders respectively.  <br>

'''If you are using this example conversion dataset, please rerun the XPSWMM model in the location where you save the dataset before beginning your own TUFLOW model conversion.''' Rerunning the model is necessary because XPSWMM will write TUFLOW files during its preprocessing, subsequently defining the correct file path information (for the location where you saved your files) in the newly written TUFLOW files. We also recommend creating your own TUFLOW model in a different folder from the provided TUFLOW dataset so you can easily compare your model against it.<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=
== Two Dimensional (2D) Model Elements ==
XPSWMM writes TUFLOW model files during its preprocessing of the model inputs defined in its GUI (prior to the hydraulic calculations). By default, XPSWMM usually writes the TUFLOW files to the '''2D\Data''' folder. For use by TUFLOW, some 2D model elements within the XPSWMM model must be exported and formatted. To accomplish this, please follow the links provided below: 

<ol>
<li> <u>[[XPSWMM_Conversion_DTM_Archive | Digital Terrain Model (DTM) Data Processing]]</u>
<li> <u>[[XPSWMM_Conversion_TUFLOW_Structure_Archive | Convert XPSWMM Model to Recommended TUFLOW Structure]]</u>
<li> <u>[[XPSWMM_Conversion_Load_TUFLOW_Model_Archive | Load Model in QGIS]]</u>
</ol>

== One Dimensional (1D) SWMM Model Elements ==
The 1D culvert, pipe network, and sub-catchment hydrology EPA SWMM items from XPSWMM require exporting and reconfiguring for compatibility with TUFLOW. Please follow the suggested workflow and instructions provided in the links below: 

<ol>
<li> <u>[[XPSWMM_Conversion_Export_SWMM_Pipe_Network_Data_Archive | Export 1D EPA SWMM Pipe Network Data from XPSWMM]]</u>
<li> <u>[[XPSWMM_Conversion_Reconfigure_SWMM_Pipe_Network_Data_Archive | Configure 1D EPA SWMM Pipe Network Data for TUFLOW]]</u>
<li> <u>[[XPSWMM_Conversion_Export_SWMM_Hydrology_Archive | Export SWMM Hydrology]]</u>
<li> <u>[[XPSWMM_Conversion_Reconfigure_SWMM_Junctions_Archive | Update SWMM Junction Data]]</u>
<li> <u>[[XPSWMM_Conversion_Export_SWMM_INP_Archive | Export Updated SWMM INP Files]]</u>
</ol>

= TUFLOW Control Files Updates =
The linking between 2D TUFLOW and 1D SWMM is established within the TUFLOW control files. The following sections (linked below) outline the basic commands needed to complete the linking process and execute the model. These tasks require the use of a text editor. The tutorial demonstration uses Notepad++. For configuration information, refer to <u>[[NotepadPlusPlus_Tips | Notepad++ Tips]]</u>. For a clean and organized model, it is recommended to name all the TUFLOW control files similarly. For example, '''1D2D_Urban_001.tscf''', '''1D2D_Urban_001.tbc''', '''1D2D_Urban_001.tgc''', and '''1D2D_Urban_5m_001.tcf'''. <br>

''Note: For this demonstration, all commands will reference the datasets in the provided conversion model. Please update these references with the filenames used in your model if you are using these steps as a guide to convert your own XPSWMM model to TUFLOW.<br>''

<ol>
<li><u> [[XPSWMM_Conversion_TUFLOW_SWMM_Control_File_(TSCF)_Archive | TUFLOW SWMM Control File (TSCF)]]</u>
<li><u> [[XPSWMM_Conversion_TUFLOW_Boundary_Control_File_(TBC)_Archive | TUFLOW Boundary Control File (TBC)]]</u>
<li><u> [[XPSWMM_Conversion_TUFLOW_Geometry_Control_File_(TGC)_Archive | TUFLOW Geometry Control File (TGC)]]</u>
<li><u> [[XPSWMM_Conversion_TUFLOW_Control_File_(TCF)_Archive | TUFLOW Control File (TCF)]]</u>
<li><u> [[XPSWMM_Conversion_TUFLOW_Control_File_Formatting_Archive | Optional: Format TUFLOW Control Files]]</u>
</ol>

= TUFLOW Simulation Execution =
Set up a simple batch file (.bat) to run TUFLOW. This approach calls the TUFLOW executable file (.exe) and runs the TCF file.
<ol>
<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="black"><tt>"..\..\exe\2023-03-AD\TUFLOW_iSP_w64.exe" 1D2D_Urban_001.tcf</tt></font> <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>

TUFLOW simulations can be executed via numerous ways. A comprehensive summary of the most commonly used approaches is documented in the <u>[[Running_TUFLOW | Running TUFLOW]]</u> Wiki page.

=== Troubleshooting ===
Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: <u>[[TUFLOW_SWMM_Troubleshooting | TUFLOW SWMM Troubleshooting]]</u>.<br>

= 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-catalogue/tt001e-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.

=Recommended Further Reading=
For users who wish to get a better understanding of either 2D TUFLOW or 1D EPA SWMM, the following resources may be of use:<br>
'''TUFLOW''': <u>[https://www.tuflow.com www.tuflow.com]</u> 
*<u>[https://www.tuflow.com/downloads/#tuflow TUFLOW User Manual]</u> 
*<u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/ TUFLOW 2023-03-AD release notes]</u> 
*<u>[[Tutorial_Introduction#Tutorial_Modules | TUFLOW Tutorial Models]]</u>

<br>
'''EPA SWMM''': <u>[https://www.epa.gov/water-research/storm-water-management-model-swmm www.epa.gov]</u> 
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]</u> 
*<u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume2_Hydaulics_P100S9AS.pdf SWMM5 Reference Manual - Volume 2 (Hydraulics) ]</u> 
*<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_Manual.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>



{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}