View source for Tutorial Troubleshooting QGIS

= Introduction =
This troubleshooting page contains common errors and steps to follow when investigating models.<br>
<br>

=Common Errors=
===Unsaved Control Files===
When changes are made in the control files and the files are not saved, errors occur. 
<ol>
<li>Check all simulation control files and batch files are saved ([[File:Notepad Saved Icon.png]]). A red icon indicates that there are unsaved changes in the file:<br>
<br>
[[File:Troubleshooting CommonErrors 01.png]]<br>
<br>
<li>Use the 'Save All' tool to save all unsaved control files:<br>
<br>
[[File:Animation Troubleshooting CommonErrors 12.gif]]<br>
<br>
</ol>

===Unsaved GIS Layers===
When changes are made in GIS layers and the layers are not saved, errors occur. 
<ol>
<li>Check all GIS input layers are saved. If the 'Save Layer Edits' icon is available ([[File:QGIS UnsavedEdits.png]]), there are unsaved edits in the layer. 
<li>A pencil icon on the layer ([[File:QGIS ToggleEditing.png]]) indicates that the layer is still editable and may contain unsaved edits. It is recommended to always turn off editing for all input layers. <br>
<br>
[[File:Animation Troubleshooting CommonErrors 02a.gif]]<br>
<br>
</ol>

===TUFLOW Syntax Rules===
Control files use a double equal sign (==). When a single equal sign is used, the simulation stops with and error at the end of the .tlf file:<br>
<br>
<ol>
[[File:Troubleshooting CommonErrors 15.png]]<br>
</ol>
<br>

===Typos in Control Files===

Typos in control files are common, with the majority resulting in a 'does not exist' pop up message:<br>
<br>
<ol>
[[File:Troubleshooting CommonErrors 03.png]]<br>
</ol>
<br>
To fix the reference:
<ol>
<li>The file that cannot by found is '''M02_01.tgc'''. Go to the folder where the file should be (in this example the '''TUFLOW\model''' folder). 
<li>The file referenced should be M02_'''001'''.tgc.
<li>Update the reference in the TCF and confirm the file can now be found by right clicking on the file and selecting open. <br>
<br>
[[File:Animation Troubleshooting CommonErrors 04.gif]]<br>
<br>
</ol>

===Typos in Input Layers===
Typos in input layers are common, resulting in a 'does not exist' pop up message:<br>
<br>
<ol>
[[File:Troubleshooting CommonErrors 13.png]]<br>
</ol>
<br>
To fix the reference:
<ol>
<li>The layer that cannot by found is '''1d_nwk_M03_culverts_001_L.shp'''. Go to the folder where the file should be (in this example the '''TUFLOW\model\gis''' folder). 
<li>The layer has a spelling mistake 'culvrts'.
<li>In QGIS use the 'Increment Selected Layer' tool to save the file with the correct name.<br> 
Note: The tool automatically increments a number if it is at the end of the file name.<br>
<br>
[[File:Animation Troubleshooting CommonErrors 14.gif]]<br>
</ol>
<br>

=Troubleshooting Steps=
=== Simulation DOS Window Flashes and Disappears ===
When batch file is double clicked and the simulation DOW window flashes and disappears the problem might be in the filepath of the TUFLOW executable or incorrect syntax:
<ol>
<li>Check the location of the TUFLOW executable. Right click on the .exe from the batch file and ensure that the executable can be found.
<li>Double click the executable, this performs a licence check and DOS window appears. If it doesn't, move the executable to a location where it is permitted to run. Some locations on C drive might be restricted for some users preventing to execute the simulation.
<li>TUFLOW doesn't run from a batch file if the filepaths are specified as UNC paths. The folder with both, the executable and the model, must be opened with a mapped drive. Type "net use <drive>: \\server_name\share_name" in the command line to map the drives.
<li>If using environment variable 'set exe', confirm there are no spaces surrounding the equals sign (e.g. set exe="..\..\..\..\exe\2020-10-AD\TUFLOW_iSP_w64.exe").
<li>Write 'pause' at the end of the script, rerun the batch file and the DOS window should remain open giving more information. In the below example, the file path to the TUFLOW exe is incorrect:<br>
<br>
[[File:Animation Troubleshooting CommonErrors 05a.gif]]<br>
<br>
</ol>

=== _ TUFLOW Simulations (*.log) ===
The log file contains brief overview of the simulation:
<ol>
<li>Navigate to the '''TUFLOW\runs''' folder and open the '''_ TUFLOW Simulations.log''' in a text editor. 
<li>Confirm if the simulation has 'Started' and 'Finished' line.
<li>If there is no log file, see <u>[[Draft_Troubleshooting#DOS_Window_Flashes_and_Disappears | here]]</u>.
</ol>

=== TUFLOW Log File (*.tlf) ===
The .tlf file contains information on the model run status and any error messages:
<ol>
<li>Navigate to the '''TUFLOW\runs\log''' folder and open the '''.tlf''' file in a text editor.<br>
<li>Scroll to the bottom to confirm the model run finished successfully by observing "Simulation FINISHED".
<li>If not, search from the bottom up for any error, warning or check messages.
<li>Review the error number, open the link provided in a web browser and read through the description and suggestions:<br>
<br>
[[File:Animation Troubleshooting CommonErrors 07a.gif]]<br>
<br>
<li>Open the .qgs workspace in QGIS from the '''TUFLOW\runs\log''' folder.
<li>Click 'Apply TUFLOW Styles to All Layers'.
<li>Zoom in to the location of any error messages, turn on labelling to view the error. <br>
<li>In this example the 2d_bc SX point isn't snapped to the 1d_nwk culvert.<br>
<br>
[[File:Animation Troubleshooting CommonErrors 08a.gif]]<br>
<br>
<li>If no error messages appear in the .tlf and the last line shows 'Sending initialisation data to HPC...' see <u>[[Tutorial_Troubleshooting_QGIS#HPC_TUFLOW_Log_File_.28.2Ahpc.tlf.29 | HPC TUFLOW Log File]]</u> below.<br>
<br>
</ol>

=== HPC TUFLOW Log File (*.hpc.tlf) ===
The .hpc.tlf file contains error messages not recorded in the .tlf file:
<ol>
<li>Navigate to the '''TUFLOW\runs\log''' folder and open the '''.hpc.tlf''' file in a text editor. If the last lines shows:<br>
<br>
[[File:Troubleshooting CommonErrors 11.png]]<br>
<br>
<li>The model is set up to run on GPU and there is no GPU available, or
<li>The GPU needs a driver update, for more information see <u>[https://wiki.tuflow.com/index.php?title=GPU_Setup Update GPU Driver]</u>.
</ol>
<br>

=Conclusion=
If the above tips do not assist in fixing the error, email [mailto:support@tuflow.com support@tuflow.com].

<br>

{{Tips Navigation
|uplink=[[Tutorial_Introduction| Back to Tutorial Introduction Main Page]]
}}