Tutorial Troubleshooting QGIS: Difference between revisions

Content deleted Content added
 
(40 intermediate revisions by 5 users not shown)
Line 9:
<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 01Troubleshooting_CommonErrors_01a.png]]<br>
<br>
<li>Use the 'Save All' tool to save all unsaved control files:<br>
<br>
[[File:Animation Troubleshooting CommonErrors 12Troubleshooting_CommonErrors_12.gifpng]]<br>
<br>
</ol>
Line 23:
<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>
{{Video|name=Animation_Troubleshooting_CommonErrors_02c.mp4}}<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 16Troubleshooting_CommonErrors_16b.png]]<br>
<br>
[[File:Troubleshooting CommonErrors 15Troubleshooting_CommonErrors_15a.png]]<br>
</ol>
<br>
 
===TyposSpelling Mistakes in Control Files===
 
TyposSpelling mistakes in control files are a common, with the majoritymistake, resulting in a 'does not exist' pop up message:<br>
<br>
<ol>
[[File:Troubleshooting CommonErrors 03Troubleshooting_CommonErrors_03b.png]]<br>
</ol>
<br>
To fix the reference:
<ol>
<li>The file that cannot by found is '''M02_01M01_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_M01_'''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>
{{Video|name=Animation_Troubleshooting_CommonErrors_04a.mp4|width=1128}}<br>
[[File:Animation Troubleshooting CommonErrors 04.gif]]<br>
<br>
</ol>
 
===TyposSpelling Mistakes in Input Layers===
TyposSpelling mistakes in input layers are also a common mistake, resulting in a 'does not exist' pop up message:<br>
<br>
<ol>
[[File:Troubleshooting CommonErrors 13Troubleshooting_CommonErrors_13a.png]]<br>
</ol>
<br>
To fix the reference:
<ol>
<li>The layer that cannot by found is '''1d_nwk_M03_culverts_001_L2d_bc_M03_culverts_001_P.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 'culvrtsculvets'.
<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>
{{Video|name=Animation_Troubleshooting_CommonErrors_14b.mp4|width=1217}}<br>
[[File:Animation Troubleshooting CommonErrors 14.gif]]<br>
</ol>
<br>
 
===TCF does not exist===
Typos or spaces in the batchTCF filename result in a 'does not exist' message in the DOSconsole window, in this example underscores were missing from the TCF reference in the batch file:<br>
<ol>
<li>Check the name of the TCF is referenced correctly in the batch file.
<li>Right click on the TCF in the batch file, select 'Open File' to make sure it can be opened.<br>
<li>Example of incorrect TCF name missing an underscore:<br>
<br>
[[File:Troubleshooting CommonErrors 1719.png]]<br>
<br>
[[File:Troubleshooting_CommonErrors_20a.png]]<br>
<br>
<li>Example of using space in the TCF name causing TUFLOW to look for a TCF name ending with the first space:<br>
<br>
[[File:Troubleshooting_CommonErrors_17a.png]]<br>
<br>
</ol>
 
===Ambiguous Command===
TUFLOW control files are command driven text files. The commands must be in the format and location TUFLOW is expecting. The <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> lists all the available commands and specifies which TUFLOW control file each command belongs to.<br>
<ol>
<li>Example of a typo in the 'BC Control File ==' command: <br>
<br>
[[File:Troubleshooting_CommonErrors_18b.png]]<br>
<br>
<li>Example of 'Map Output Data Types ==' command entered into TGC instead of TCF: <br>
<br>
[[File:Troubleshooting_CommonErrors_21b.png]]<br>
</ol>
<br>
 
===Editing File Extension===
When creating a control file from a .txt file, the file extension should be edited to reflect the control file type, such as .tgc, .tbc or .tcf. If the file extensions are hidden in Windows File Explorer, the intended changes to the file extension may be applied to the file name rather than the extension. This could result in control files being referenced incorrectly, which may cause the error message [[TUFLOW_Message_0008 | ERROR 0008]] - <filename> cannot be found.
 
To edit file extensions correctly, ensure file extensions are displayed by enabling the following option within Windows File Explorer:
 
<b> Windows 10 </b> <br>
<ol>[[File:File Ext Win10.png]]</ol>
 
 
<b> Windows 11 </b><br>
<ol>[[File:File Ext Win11.png]]</ol>
 
=Troubleshooting Steps=
=== Simulation DOSConsole Window Flashes and Disappears ===
When batch file is double clicked and the simulation DOWconsole window flashes and disappears the problem might be in the filepath of the TUFLOW executable or incorrect syntax:
<ol>
<li>Check the TUFLOW executable can be found with the specified filepath (absolute or relative).
<li>Double click the executable, this performs a licence check and DOSconsole 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\20202023-1003-ADAA\TUFLOW_iSP_w64.exe").
<li>Write 'pause' at the end of the script, rerun the batch file and the DOSconsole window should remain open providing more information. In the below example, the file path to the TUFLOW exe is incorrect:<br>
<br>
{{Video|name=Animation_Troubleshooting_CommonErrors_05b.mp4|width=1124}}<br>
[[File:Animation Troubleshooting CommonErrors 05a.gif]]<br>
<br>
</ol>
Line 98 ⟶ 134:
<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_TroubleshootingTutorial_Troubleshooting_QGIS#DOS_Window_Flashes_and_DisappearsSimulation Console Window Flashes and Disappears | here]]</u>.
</ol>
 
Line 109 ⟶ 145:
<li>Review the error number, open the link provided in a web browser and read through the description and suggestions:<br>
<br>
{{Video|name=Animation_Troubleshooting_CommonErrors_07b.mp4|width=1265}}<br>
[[File:Animation Troubleshooting CommonErrors 07a.gif]]<br>
<br>
<li>Open the .qgs workspace in QGIS from the '''TUFLOW\runs\log''' folder.
Line 116 ⟶ 152:
<li>In this example the 2d_bc SX point isn't snapped to the 1d_nwk culvert.<br>
<br>
{{Video|name=Animation_Troubleshooting_CommonErrors_08b.mp4|width=1217}}<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.2Ahpc2A.hpc.tlf.29 | HPC TUFLOW Log File]]</u> below.<br>
<br>
</ol>
Line 127 ⟶ 163:
<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 11Troubleshooting_CommonErrors_11a.png]]<br>
<br>
<li>The model is set up to run on GPU and there is no GPU available, or