Revision as of 16:03, 27 February 2024

Introduction

This Wiki page outlines recommended steps for the conversion of an XPSWMM model to TUFLOW.

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 TUFLOW SWMM Tutorials. Tutorials are provided for the following topics:

TUFLOW SWMM Module 1 - 1D SWMM Culverts
TUFLOW SWMM Module 2 - 1D SWMM Pipe Network / 2D TUFLOW Direct Rainfall Hydrology
TUFLOW SWMM Module 3 - 1D SWMM Pipe Network / 1D SWMM Urban Hydrology
TUFLOW SWMM Module 4 - 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: XPSWMM to TUFLOW Model Conversion Dataset. The models are found in the XPSWMM and TUFLOW folders respectively.

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.

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 sales@tuflow.com. 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:

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:

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 Notepad++ Tips. 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.

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.

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.

Create a new text file in the TUFLOW\runs folder and save as _run_HPC.bat.
Open the _run_HPC.bat in a text editor and include a file path to the TUFLOW executable and the TCF name:
"..\..\exe\2023-03-AD\TUFLOW_iSP_w64.exe" 1D2D_Urban_001.tcf
Note: A relative path is used for the executable and the TCF, full file path can also be used.
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.

TUFLOW simulations can be executed via numerous ways. A comprehensive summary of the most commonly used approaches is documented in the Running TUFLOW Wiki page.

Troubleshooting

Did your TUFLOW SWMM model fail to run successfully? If so, here is a link to a troubleshooting guide: TUFLOW SWMM Troubleshooting.

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: Introduction to QGIS for TUFLOW.
Our TUFLOW SWMM Tutorials also demonstrate working with TUFLOW SWMM results.

Feedback / Suggestions

We hope you have found this model conversion page helpful. If you have any feedback or suggestions, please email support@tuflow.com.

Up
Back to Wiki Main Page

@@ Line 1: / Line 1: @@
-<font size = 18>Page Under Construction - Expected Finalization date: 23 February 2024 </font>
 = Introduction =
-This Wiki page outlines recommended steps for conversion of an XPSWMM model to TUFLOW. <br>
+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). During simulation, XPSWMM calls a TUFLOW dynamic library for the 2D calculations. As XPSWMM uses TUFLOW for its 2D engine, XPSWMM and TUFLOW use the same 2D solution and will achieve identical results if configured in a like-for-like way.
+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 inefficient in workflow 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 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.
+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: / Line 12: @@
 * <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.
-== TUFLOW Licensing / XPSWMM Discount ==
+== Dataset Download ==
-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 an XPSWMM / TUFLOW discount in recognition of past royalties Autodesk paid TUFLOW when you purchased an XPSWMM perpetual license. <br>
+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>
-== Dataset Download ==
+'''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>
-The XPSWMM model used for this model conversion demonstration is available for download here: <u>[https://downloads.tuflow.com/SWMM/XPSWMM_to_TUFLOW_Model_Conversion.zip XPSWMM to TUFLOW Model Conversion Dataset]</u>. A copy of the completed converted model can be downloaded at the end of the page.  <br>
-'''If you are using this example conversion dataset, please rerun the XPSWMM model before beginning the conversion process.''' This will generate the XPSWMM TUFLOW files and establish the correct file paths within them, aligning with the location where you have saved the dataset on your computer.
+== 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 when it pre-processes the model inputs defined in its GUI (prior to the hydraulic calculations). Using default settings, XPSWMM typically writes the TUFLOW files to the '''2D\Data''' folder. follow these steps to extract and format the XPSWMM / TUFLOW 2D model features.<br>
+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>
@@ Line 32: / Line 31: @@
 == One Dimensional (1D) SWMM Model Elements ==
-The 1D culvert, pipe network and sub-catchment hydrology EPA SWMM items in the XPSWMM model need to be exported from the software and reconfigured for use by TUFLOW. Please follow the suggested workflow and instructions outlined below:
+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>
@@ Line 39: / Line 38: @@
 <li> <u>[[XPSWMM_Conversion_Export_SWMM_Hydrology | Export SWMM Hydrology]]</u>
 <li> <u>[[XPSWMM_Conversion_Reconfigure_SWMM_Junctions | Update SWMM Junction Data]]</u>
-<li> <u>[[XPSWMM_Conversion_Export_SWMM_INP | Export Update SWMM INP Files]]</u>
+<li> <u>[[XPSWMM_Conversion_Export_SWMM_INP | Export Updated SWMM INP Files]]</u>
 </ol>
-= TUFLOW Control File Updates =
+= TUFLOW Control Files Updates =
-The linking between the 2D TUFLOW model and 1D SWMM is established within the TUFLOW control files. The following steps outline the basic commands needed to complete the linking process and execute the model.
+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>
-The following steps will require use of a text editor. The tutorial demonstration uses Notepad++. For its 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.<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) | TUFLOW SWMM Control File (TSCF)]]</u>
 <li><u> [[XPSWMM_Conversion_TUFLOW_Boundary_Control_File_(TBC) | TUFLOW Boundary Control File (TBC)]]</u>
-<li><u> [[XPSWMM_Conversion_TUFLOW_Geometry_Control_File_(TBC) | TUFLOW Geometry Control File (TGC)]]</u>
+<li><u> [[XPSWMM_Conversion_TUFLOW_Geometry_Control_File_(TGC) | TUFLOW Geometry Control File (TGC)]]</u>
 <li><u> [[XPSWMM_Conversion_TUFLOW_Control_File_(TCF) | TUFLOW Control File (TCF)]]</u>
 <li><u> [[XPSWMM_Conversion_TUFLOW_Control_File_Formatting | 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.
-== Simulation Control Files ==
+=== 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 Geometry Control File (TGC) ===
-The TUFLOW Geometry Control File (TGC) contains a series of commands that build the geometry model. At its minimum, the TGC contains:
-:* Information on the size and orientation of the grid;
-:* Grid cell codes (whether cells are active or inactive);
-:* Bed / ground elevations; and
-:* Bed material type or flow resistance value.
-<br>
-The TGC requires no updates; however, it is recommended to review the TGC before running the simulation to ensure all commands are correct.
-<br><br>
-=== TUFLOW Control File (TCF) ===
+= TUFLOW SWMM Result Viewing =
-The TCF file references all the control files, specifies time and output controls.<br>
+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.
-In the <u>[[#Convert_XPSWMM_Model_to_Recommended_TUFLOW_Structure | Convert XPSWMM Model to Recommended TUFLOW Structure]]</u> section, the <u>[[Convert_TUFLOW_Model_GIS_Format |Convert TUFLOW Model GIS Format]]</u> processing tool utilizes the TUFLOW control files generated by XPSWMM to construct the TUFLOW SWMM model control files. During this process, the tool updates the commands within the TUFLOW control files to align with the requirements of a TUFLOW SWMM model. However, since the original control files were intended for use with XPSWMM, they lack the commands required to execute a TUFLOW simulation. Additionally, these files often contain unnecessary and/or outdated commands.<br>
+=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>
-In the section above, the TBC was edited to reflect the model updates implemented during the conversion process, while no updates were necessary for the TGC. However, the TCF requires updating to ensure the TUFLOW SWMM model runs smoothly.
-<ol>
-<li> Remove or comment out the commands listed below.
-{|
-|style="width: 50%"| <font color="blue"><tt>Check MI Save Date </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>Mass Balance Output Interval (s) </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>MI Projection </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>CSV Time </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>MI Projection Check </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>Viscosity Formulation </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>Timestep (s) </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>Viscosity Coefficient </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>Cell Wet/Dry Depth </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>SX ZC Check </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>Read GIS XP Nodes </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>SX Storage Approach </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>Simulations Log Folder </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>HX ZC Check </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>Store Maximums and Minimums </tt></font> <font color="red"><tt>== </tt></font>
-|<font color="blue"><tt>Mass Balance Corrector </tt></font> <font color="red"><tt>== </tt></font>
-|-
-|<font color="blue"><tt>Mass Balance Output </tt></font> <font color="red"><tt>== </tt></font>
-|}
-<li> Make the following updates:
-{|class="wikitable"
-! Original Command
-! Updated Command
-|-
-|<font color="blue"><tt>GPKG Projection </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>1D2D_Urban_001_proj</tt></font>
-|<font color="blue"><tt>GPKG Projection </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>??</tt></font>
-|-
-|<font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>OFF</tt></font>
-|<font color="blue"><tt>Write Check Files </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\check\</tt></font>
-|-
-|<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\results\Output </tt></font>
-|<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\results\</tt></font>
-|-
-|<font color="blue"><tt>Log Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>log\Log </tt></font>
-|<font color="blue"><tt>Output Folder </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>log</tt></font>
-|-
-|<font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>qVdhZ0 </tt></font>
-|<font color="blue"><tt>Map Output Data Types </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>q V d h Z0</tt></font>
-|-
-|<font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>XMDF </tt></font>
-|<font color="blue"><tt>Map Output Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>XMDF TIF</tt></font>
-|}
-<li> Add the following commands:<br>
-<font color="blue"><tt>Tutorial Model </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>ON </tt></font> <font color="green"><tt> ! Required command to run this tutorial model licence free</tt></font><br>
-<font color="blue"><tt>GIS Format </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>GPKG </tt></font> <font color="green"><tt> ! Specify GPKG as the output format for all GIS files</tt></font><br>
-<font color="blue"><tt>Solution Scheme </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>HPC </tt></font> <font color="green"><tt> ! Heavily Parallelised Compute, uses adaptive timestepping</tt></font><br>
-<font color="blue"><tt>Hardware </tt></font> <font color="red"><tt>== </tt></font> <font color="blue"><tt>CPU </tt></font> <font color="green"><tt> ! Replace with "Hardware == GPU" if GPU available </tt></font><br>
-<font color="blue"><tt>Start Time </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>0 </tt></font> <font color="green"><tt> ! Specifies the simulation start time (0 hours) </tt></font><br>
-<font color="blue"><tt>End Time </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>3 </tt></font> <font color="green"><tt> ! Specifies the simulation end time (3 hours)</tt></font><br>
-<font color="blue"><tt>TIF Map Output Interval </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>0 </tt></font> <font color="green"><tt> ! Outputs only maximums for grids</tt></font><br>
-<li> Add the following command to reference the TUFLOW SWMM Control File (TSCF):<br>
-<font color="blue"><tt>SWMM Control File </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>..\model\1D2D_Urban_001.tscf</tt></font>
-<li> Save the TCF.
-<br><br>
-'''<font color="red> Video </font>'''
 <br>
-</ol>
+'''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>
-=== Optional: Format TUFLOW Control Files ===
+=Feedback / Suggestions=
-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:
+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>.
-:* Using relative file paths to specify the location of various files and layers in the model.
-:* 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>.
-:* 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.
-:* 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>
-<br>
-If using the provided model conversion dataset, the final Control files should look like this:<br>
-'''<font color="red"> insert images when dataset finalised </font>'''
 <br>
-= TUFLOW Simulation Execution =
-=Converted Dataset=
-After completing the model conversion steps outlined above, you can download the converted TUFLOW SWMM model dataset using the following link: '''<<link>>'''
-This dataset includes both the original XPSWMM model and the converted TUFLOW model. We recommend checking your converted TUFLOW model against the provided one to ensure all conversion steps were completed correctly.
-<br>
-<br>
-=Feedback / Suggestions=
-If you have any suggestions to be included in these pages, please email <u>[mailto::support@tuflow.com support@tuflow.com]</u>.
 {{Tips Navigation
-|uplink=[[Main_Page| Back to Main Page]]
+|uplink=[[Main_Page| Back to Wiki Main Page]]
 }}

Difference between revisions of "XPSWMM to TUFLOW-SWMM"