TUFLOW crashing: Difference between revisions

Browse history interactively

← Older edit

Content deleted Content added

VisualWikitext

Revision as of 10:43, 13 May 2022 view source Pavlina Monhartova (talk \| contribs) Bureaucrats, Administrators 5,366 edits →Simulation DOS window flashes and disappears ← Older edit		Latest revision as of 17:30, 3 September 2025 view source Pavlina Monhartova (talk \| contribs) Bureaucrats, Administrators 5,366 edits →TUFLOW crashes at the end of the simulation before writing out maximum results
(22 intermediate revisions by 4 users not shown)
Line 1: ~~<font color="red"><tt>'''This Page is under construction''' </tt></font>~~ =Introduction= From time to time TUFLOW simulations can crash. There are multiple reasons why it could happen. This page can be used as a guide to find and rectify the cause of the crash.<br> Line 16 ⟶ 14: =How to keep simulation console window open= ~~Simulation~~The simulation console window can display errors not written into the .tlf file and ~~provide~~often ~~more~~provides additional information useful for troubleshooting: * Insert "pause" at the end of the batch file and remove any Start "TUFLOW", -b and/or -t switch. Simple batch file as below should be used if more complex looping batch file doesn't keep the console window open even with the suggested changes. * To ensure the console window remains open, add pause at the end of the batch file and remove any Start "TUFLOW", -b, or -t switches. If the console window still closes, use a simplified batch file like the example below. The simulation console window is the one stating with the TUFLOW build, for example "TUFLOW Build: 2020-10-AD-iSP-w64" in the header's top left corner.▼ The batch file console window stating "C:\\WINDOWS\system32\cmd.exe" in the header's top left corner won't provide desired information. ~~<pre>~~ "C:\TUFLOW\Releases\2020-10-AD\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf"~~</pre>~~ pause~~</pre>~~▼ ▲*:The simulation console window is the one ~~stating~~that ~~with~~displays the TUFLOW build~~, for~~ ~~example~~(e.g. "TUFLOW Build: ~~2020-10-AD~~2025.0.3-iSP-w64") in the ~~header's~~ top -left corner of the window header, as shown in the image below. :[[File:TUFLOW Simulation Console with Build Info Displayed.png\|frameless\|600x600px]] :If start "TUFLOW" is included in the batch file, the console window will instead show "C:\WINDOWS\system32\cmd.exe" in the window header and will not display the desired simulation output, as shown below. :[[File:Batch File Console Showing CMD Header Only.png\|frameless\|600x600px]] Or, let the console window be written to a text file. This will redirect console output messages as well as the standard error stream to the “dump.txt” file, and it will likely record more error information than the usual .tlf file. <pre>"C:\TUFLOW\Releases\2020-10-AD\TUFLOW_iSP_w64.exe" "M01_5m_001.tcf" > dump.txt</pre> <br>▼ =Simulation ~~DOS~~console 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.<br> '''Suggestions''': * Check the TUFLOW executable can be found with the specified filepath (absolute or relative). * Double click the executable, this performs a licence check and ~~DOS~~console 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. * 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. * 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"). * Write 'pause' at the end of the script, rerun the batch file and the ~~DOS~~console window should remain open providing more information <br> =TCF does not exist= The .tcf name ~~and~~or the filepath ~~might be~~is incorrect or ~~unsupported UNC paths were~~not ~~used~~supported.<br> '''Suggestions:''' * Check the name of the .tcf file and filepath (ifabsolute ~~used~~or relative) is correct. * TUFLOW doesn't ~~currently~~run ~~support~~from a batch file if the filepaths are specified as UNC paths. The folder with both, the ~~model~~executable ~~has~~and tothe model, must be opened with a mapped drive. Type "net use <drive>: \\server_name\share_name" in the command line to map ~~desired~~the ~~drive~~drives. * If your TCF file reference contains any special characters (e.g. é, ë, ä, ö… etc) you may find that TUFLOW does not find the TCF path. The best way to fix this is to make sure the batch file content (the text) and the console are using the same encoding so that the correct characters are being passed to TUFLOW. This can be achieved by using a text editor like Notepad++ to make sure the text is encoded in a chosen format (e.g. UTF-8), then using the <code>chcp [code]</code> command in the batch file to set the encoding to be identical. An example using UTF-8 is shown below. In Windows, UTF-8 has the code page code = 65001, so at the top of the batch file, set the code page to 65001 to tell the console window what encoding to expect. <ol><pre> chcp 65001 TUFLOW.exe -b spëcial.tcf </pre> </ol> <br> Line 63 ⟶ 74: * Unstable network: Use TUFLOW executable saved on a local drive. Set a local drive as the output drive for all checks, results and logs. This can be done using <font color="blue"><tt>Output Drive</tt></font> command in the .tcf. All outputs can be copied back to the network drive at the simulation end if required. Robocopy can be added to the end of the .bat file, example ~~below~~<u>[[TUFLOW_crashing#Robocopy_example_to_automatically_copy_outputs_on_network_drive_after_model_runs \| here]]</u>.<br> * Insufficient storage: Ensure storage locations that outputs are written to have enough free space. Depending on the infrastructure, reported free space may not be accurate, or performance of storage may substantially degrade as it nears being full. Line 71 ⟶ 82: Run models locally if it is known the runs will coincide with such processes. * If you need further help, send the .tlf, .hpc.tlf and <u>[[TUFLOW_crashing#How_to_keep_simulation_console_window_open \| snapshot of the console window]]</u> to [mailto:support@tuflow.com support@tuflow.com]. ~~<br>~~ <pre>@echo off▼ set TUFLOWEXE_iSP=O:\TUFLOW\Releases\2020-01\2020-10-AA\TUFLOW_iSP_w64.exe▼ set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -b▼ set A=5m 2.5m▼ set B=EXG DEV▼ set source_results=D:\TUFLOW\results▼ set source_log=D:\TUFLOW\runs▼ set destination_results=O:\TUFLOW\support\results▼ set destination_log=O:\TUFLOW\support\runs▼ FOR %%a in (%A%) do (▼ FOR %%b in (%B%) do (▼ :: Run model▼ echo Running Cell Size %%a Model Scenario %%b▼ %RUN_iSP% -s1 %%a -s2 %%b M10_~s1~_~s2~_003.tcf▼ ▼ :: Move results folder to different location▼ robocopy "%source_results%" "%destination_results%" /e /move▼ ▼ :: Move log folder to different location▼ robocopy "%source_log%" "%destination_log%" /e /move▼ timeout 5▼ )▼ )▼ ▲pause</pre> <br> =TUFLOW crashes at the end of the simulation before writing out maximum results= The output drive might not have enough free space to write out the full results. If multiple TUFLOW simulations run in parallel, the free space might be filling up faster than expected. There can also be other processes filling up the drive, e.g. other software, backups, other users copying data. The target drive should never ~~be planned to~~ be filled to the brim, as performance will suffer for all processes.<br> '''Suggestions:''' * Ensure storage locations that outputs are written to have enough free space. Depending on the infrastructure, reported free space may not be accurate, or performance of storage may substantially degrade as it nears being full. Line 114 ⟶ 96: '''Suggestions''': * Gain write permission to write to the folder from your IT staff. * Change the default log location to somewhere where you already have write permissions with TCF command <font color="blue"><tt>Simulations Log Folder </tt></font> <font color="red"><tt>== </tt></font> <tt><<folder>>"</tt>. <br> Line 123 ⟶ 105: Once a year (usually after mid-year) a new TUFLOW release will need the licence to be updated. This will show in the .tlf file as "Unmaintained since <year>". Follow <u>[[WIBU_Licence_Update_Request \| WIBU Licence Update Request]]</u> to get the licence updated. ==Console window lists all licences~~, after pressing Enter the licences are released~~ and model doesn't run== If the console window appears as shown below and ends with the line "Press ENTER to Release WIBU Licences", this indicates a licence check was performed. When a licence check is run, the TUFLOW model does not execute, and a .tlf file is not produced. What happened here is a licence check which doesn't run a TUFLOW model and doesn't produce a .tlf file. Licence check temporarily takes one licence from every available module until the licences are released by pressing Enter (released immediately) or by closing the console window (released after a couple of minutes). Once licenses are released by pressing Enter, the console window shows “Not licenced or no local licence free”. This means the licences are no longer taken by the licence check and can be used for running models.<br> During the licence check, one licence from each available module is temporarily reserved. These are released either immediately by pressing Enter, or automatically after a few minutes when the console window is closed. Once the licences are released by pressing Enter, the console window displays "Not licenced or no local licence free". This confirms that the licences are no longer reserved by the licence check and are available for running TUFLOW models.<ol> [[File: Licence_Check_2.png \| 600px]]</ol> The licence check is performed in the following situations: * Double clicking a TUFLOW executable. * Running a batch file ~~with~~that only specifies the TUFLOW executable ~~specified~~. * Running TUFLOW from Notepad++, ~~when inserting~~with only the TUFLOW executable inserted into the Run ~~window~~function text box.~~<br>~~ Suggestions to run a TUFLOW model: ~~Check these Wiki pages on how to <u>[[Running_TUFLOW \| run TUFLOW model]]</u> and how to setup <u>[[NotepadPlusPlus_Run_TUFLOW \| running TUFLOW from Notepad++]]</u>.~~ * Include the model .tcf name in the batch file. See <u>[[Running_TUFLOW \| Running TUFLOW model]]</u> for further guidance. * Insert the full required text (example line below) into Notepad++ Run function text box. See <u>[[NotepadPlusPlus_Run_TUFLOW \| Running TUFLOW from Notepad++]]</u> for further guidance. <ol> "C:\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe" "$(FULL_CURRENT_PATH)" </ol> ==Running very old TUFLOW releases== Line 136 ⟶ 125: ==No TUFLOW dongle and licence settings files found (.lcf and .dcf)== Some users might mistake this sentence in the .tlf file as there is an issue with the licence. The "No TUFLOW licence settings files found" sentence is followed by "Default settings applied" and the default settings are listed on the next three lines, e.g. WIBU Retry Time, WIBU Retry Count, WIBU Dongles Only. Only if these settings are required to be different, the licence control file (.lcf) or dongle control file (.dcf) would be ~~created~~required. Not having these licence files doesn't prevent TUFLOW from running, it would automatically use the default licence settings. The .tlf should continue past these lines and if there is an error, it would be written as the bottom of the .tlf. ==Technical licence issues== <u>[[Wibu_Dongles#Troubleshooting \| Wibu Dongles Troubleshooting]]</u><br> ▲<br> =Robocopy example to automatically copy outputs on network drive after model runs= ▲<pre>@echo off ▲set TUFLOWEXE_iSP=O:\TUFLOW\Releases\2020-01\2020-10-AA\TUFLOW_iSP_w64.exe ▲set RUN_iSP=start "TUFLOW" /wait "%TUFLOWEXE_iSP%" -b ▲set A=5m 2.5m ▲set B=EXG DEV ▲set source_results=D:\TUFLOW\results ▲set source_log=D:\TUFLOW\runs ▲set destination_results=O:\TUFLOW\support\results ▲set destination_log=O:\TUFLOW\support\runs ▲FOR %%a in (%A%) do ( ▲ FOR %%b in (%B%) do ( ▲ :: Run model ▲ echo Running Cell Size %%a Model Scenario %%b ▲ %RUN_iSP% -s1 %%a -s2 %%b M10_~s1~_~s2~_003.tcf ▲ ▲ :: Move results folder to different location ▲ robocopy "%source_results%" "%destination_results%" /e /move ▲ ▲ :: Move log folder to different location ▲ robocopy "%source_log%" "%destination_log%" /e /move ▲ timeout 5 ▲ ) ▲) pause</pre> {{Tips Navigation \|uplink=[[TUFLOW_Modelling_Guidance \| Back to TUFLOW Modelling Guidance]] }}