View source for XPSWMM to TUFLOW-SWMM Troubleshooting

<font size=3>'''This page is a work in progress. Please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u> for assistance. ''' </font>
= Introduction = 
This page provides extra guidance for converting a XPSWMM model to TUFLOW SWMM. For the full conversion process, see <u>[[XPSWMM_to_TUFLOW-SWMM|XPSWMM to TUFLOW SWMM]]</u>. 

= Model Conversion Without a XPSWMM License =
This guide outlines the steps for converting a XPSWMM model to TUFLOW SWMM without a valid XPSWMM license. Please note that this process is <u>not recommended</u> and may result in issues with the converted TUFLOW model. For assistance with converting a XPSWMM model without a license, please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u>.

If you have access to the XPSWMM Viewer but do not have a valid XPSWMM license, you can export the XPX data from the XPSWMM model. However, exporting the DTM data and 2D model files directly from the XPSWMM model is not possible. See the <u>[[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Locate_Essential_Files|Locate Essential Files]]</u> section below. To export XPX data, please follow the instructions provided, <u>[[XPSWMM_to_TUFLOW-SWMM#Export_XPX_Data_From_XPSWMM |Export XPX Data From XPSWMM]]</u>.

Without a valid XPSWMM license and access to the XPSWMM Viewer, you will not be able to export the XPX data, DTM data, or the 2D model files directly from the XPSWMM model. See the <u>[[XPSWMM_to_TUFLOW-SWMM_Troubleshooting#Locate_Essential_Files|Locate Essential Files]]</u> section below.

=== Locate Essential Files ===
Without a XPSWMM license, it is impossible to export data from a XPSWMM model directly. Instead, the best alternative is to locate the files generated during the last run of the XPSWMM model. <br>
If you do not have access to these files, please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u> for assistance. 

Search through the XPSWMM files for the following:
<ol>
<li> Exported XPX data file: Look for a file with a '''.xpx''' extension.
<li> TUFLOW control files: Files such as '''.tgc'''', '''.tbc''', '''.tcf''', etc. They are typically found in the '''2D/Data''' folder, although their location may vary depending on the XPSWMM model settings. 
<li> Grid file: A grid file with a '''.tif''', '''.flt''' or '''.asc''' extension.
<li> 2D model files: These files are in MapInfo ('''.mif'''/'''.mid''') or ShapeFile ('''.shp''') format and they contain the model data. They are typically found in the '''2D/Data''' folder.
</ol>
<br>

'''Actions based on located files:''' <br>

{| class="wikitable" style="text-align: left;" style="width: 70%;"
|-
! style="width: 30%"| '''Files Located'''
! style="width: 70%"| '''Possible Steps'''
|-
|XPX data file || Use the <u>[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]</u> processing tool. This will convert only the 1D data from the XPSWMM model. 
|-
|TUFLOW control files <br> 2D model files <br> Grid file || Use the <u>[[Convert_TUFLOW_Model_GIS_Format|Convert TUFLOW Model GIS Format]]</u> processing tool to convert the XPSWMM model into TUFLOW format. <br>
Prior to using the tool, the references within the TUFLOW control files must be updated. As XPSWMM uses absolute file paths, if your XPSWMM model is in a different folder location to where it was run originally, all the references will be incorrect. To fix this, update the commands in each control file to have relative file path references. For example, <br>
: <tt><font color="blue">Output Folder </font><font color="red">== </font>C:\XPSWMM_XPX_to_TUFLOW_Conversion\XPSWMM\2D\Output</tt> 
: becomes...
: <tt><font color="blue">Output Folder </font><font color="red">== </font>..\Output</tt><br>

Carefully review the output to ensure all data has been converted correctly. Some steps in the <u>[[XPSWMM_to_TUFLOW-SWMM_Archive|XPSWMM to TUFLOW SWMM Archive]]</u> process may be useful. <br>

'''Note:''' This process can be done without a grid file, but the converted TUFLOW model will not include one. If possible, try to locate the model's grid file or create a new one.
|-
|XPX data file <br> TUFLOW control files (in particular .tcf) <br> Grid file || Proceed with the main conversion process, <u>[[XPSWMM_to_TUFLOW-SWMM#Convert_XPSWMM_Model_to_TUFLOW_SWMM |Convert XPSWMM Model to TUFLOW SWMM]]</u>. <br>
'''Note:''' This process can be done without a grid file, but the converted TUFLOW model will not include one. If possible, try to locate the model's grid file or create a new one.
|}

= Common Conversion Issues = 
Any issues that may have occurred while running the <u>[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]</u> processing tool will be documented in the '''*_convert_messages.gpkg'''. This file is located in the '''TUFLOW/model/swmm''' folder of the converted TUFLOW model. Drag and drop this GeoPackage into QGIS and turn on labels to view any conversion messages and their locations. 

There are different levels to the messages:
:* An 'Error' will abort the <u>[[QGIS_SWMM_Convert_XPSWMM_Model_From_XPX|Convert - XPSWMM model from XPX]]</u> processing tool and therefore may not generate a '''*_convert_messages.gpkg'''. However, there will be a description of the error in the tools log. 
:* Both 'Warnings' and 'Checks' will not abort the conversion process, and they will both be reported in the '''*_convert_messages.gpkg''' and the tools log. A warning is more severe then a check, however both messages should be reviewed to determine the cause.

The information provided in the processing tool log and/or the messages GeoPackage should be sufficient for identifying the location and cause of the issue(s) in the TUFLOW model. The <u>[[XPSWMM_to_TUFLOW-SWMM#Recommended_Additional_Conversion_Steps|Recommended Additional Conversion Steps]]</u> are applicable to the most common conversion issues. For other issues, some sections of the <u>[[XPSWMM_to_TUFLOW-SWMM_Archive|XPSWMM to TUFLOW SWMM Archive]]</u> process may be helpful. If the issue(s) persists, please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u> for further assistance. 



{{Tips Navigation
|uplink=[[XPSWMM_to_TUFLOW-SWMM| Back to XPSWMM to TUFLOW SWMM Conversion Page]]
}}