Tutorial Troubleshooting QGIS

Introduction

This troubleshooting page contains common errors and steps to follow when investigating models.

Common Errors

Unsaved Control Files

When changes are made in the control files and the files are not saved, errors occur.

1. Check that all simulation control files and batch files are saved (). A red icon indicates that there are unsaved changes in the file:
   
   
   
   

Unsaved GIS Layers

When changes are made in GIS layers and the layers are not saved, errors occur.

1. Check that all GIS input layers have been saved. If the 'Save Layer Edits' icon is available (), there are unsaved edits in the layer.
2. A pencil icon on the layer () indicates that the layer is still editable and may contain unsaved edits. It is recommended to always turn off editing for all input layers.
   
   
   
   

Typos in Control Files

Typos in control files are common, resulting in a 'does not exist' pop up:



To fix the reference:

1. Locate the file that cannot by found, in this example it is M02_01.tgc.
2. Review what the model file is called (navigate to the TUFLOW\model folder).
3. The file referenced should be M02_001.tgc.
4. Update the reference in the TCF and confirm the file can now be found by right clicking on the file and selecting open.
   
   
   
   

Troubleshooting Steps

DOS Window Flashes and Disappears

If a batch file has been clicked and a DOS window flashes up and disappears:

1. 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.
2. 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.
3. 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").
4. Check where the model and executable are located. We recommend to not use the C drive or an external hard drive.
5. 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.
6. 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:
   
   
   
   

_ TUFLOW Simulations (*.log)

1. Navigate to the TUFLOW\runs folder and open the _ TUFLOW Simulations.log in a text editor.
2. Confirm if the simulation has 'Started' and 'Finished'.
3. If there is no log file, see here.

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:

1. 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.
2. Review the Error number and open the link provided in a web browser:
   
   
   
   
3. Open the workspace in QGIS from the TUFLOW\runs\log folder.
4. Click 'Apply TUFLOW Stying'.
5. Zoom in to the location of any error messages, turn on labelling to view the error.
   
   
   
   

HPC TUFLOW Log File (*hpc.tlf)

If there is no error message in the TLF and the last lines show:

1. The model has been set up to run on GPU and there is no GPU available, or
2. The GPU needs a driver update, for more information see Update GPU Driver.

Conclusion

If the above tips do not assist in fixing the error, email support@tuflow.com.

Up
Back to Tutorial Introduction Main Page