pytuflow.TCFRunState.test

pytuflow.TCFRunState.test#

TCFRunState.test(tuflow_bin, prec='sp')#

Run the control file in context using the specified TUFLOW binary in test mode.

The stdout and stderr are automatically captured (no console window is produced) and once complete, the return values are the captured stdout and stderr.

Parameters:

  • tuflow_bin (PathLike) – File path to the TUFLOW binary or a registered version name.

  • prec (str, optional) – Precision of the run. Default is "sp" (single precision). Alternate option is to use "dp" (double precision) (accepted aliases "idp" and "double").

Returns:

Captured stdout and stderr from the run.

Return type:

tuple[str, str]

Examples

>>> tcf = ... # assuming is an instance of TCF
>>> stdout, stderr = tcf.context().test('2025.1.2')
>>> print(stderr)
NoXY: ERROR 2131 - Reading parameter(s) or option for .tcf command below, or command is ambiguous.
Contents