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 that 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>
</ol>

===Unsaved GIS Layers===
When changes are made in GIS layers and the layers are not saved, errors occur. 
<ol>
<li>Check that all GIS input layers have been 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 02.gif]]<br>
<br>
</ol>

===Typos in Control Files===
Typos in control files are common, resulting in a 'does not exist' pop up:<br>
<br>
[[File:Troubleshooting CommonErrors 03.png]]<br>
<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>

=Troubleshooting Steps=
=== DOS Window Flashes and Disappears ===
If a batch file has been clicked and a DOS window flashes up and disappears:
<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 and open. 
<li>Check the location of the TCF. Right click on the TCF from the batch file and ensure that the file can be found and open.
<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>Check where the model and executable are located. We recommend to '''not''' use the C drive or an external hard drive.
<li>TUFLOW doesn't currently support UNC paths. The folder with the executable has to be opened with a mapped drive. Type "net use <drive>: \\server_name\share_name" in the command line to map desired drive.
<li>Write 'pause' at the end of the script. Re-run the batch file and the DOS window remains, giving some 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) ===
<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'.
<li>If there is no log file, see <u>[[Draft_Troubleshooting#DOS_Window_Flashes_and_Disappears | here]]</u>.
</ol>

=== TUFLOW Log File (*.tlf) ===
Open the TUFLOW log file (*.tlf) and confirm at the bottom of the file, that the model run finished successfully by observing "Simulation FINISHED". If the simulation has not finished:
<ol>
<li>Scroll to the bottom of the TLF, work from the bottom up to review any error, check or warning messages. If no error messages appear, see XX.
<li>Review the Error number and open the link provided in a web browser:<br>
<br>
[[File:Animation Troubleshooting CommonErrors 07a.gif]]<br>
<br>
<li>Open the workspace in QGIS from the '''TUFLOW\runs\log''' folder.
<li>Click 'Apply TUFLOW Stying'.
<li>Zoom in to the location of any error messages, turn on labelling to view the error. <br>
<br>
[[File:Animation Troubleshooting CommonErrors 08.gif]]<br>
<br>
</ol>

=== HPC TUFLOW Log File (*hpc.tlf) ===
If there is no error message in the TLF and the last lines show:<br>
<br>
[[File:Troubleshooting CommonErrors 11.png]]<br>
<br>
<ol>
<li>The model has been 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]]
}}