pytuflow.FVCRunState.run

FVCRunState.run(tuflowfv_bin, add_cli_args=(), *args, **kwargs)

Run the control file in context using the specified TUFLOWFV binary.

• TUFLOWFV binary can be a file path to the executable or a version name that has been registered using

  the register_tuflowfv_binary() or the register_tuflow_binary_folder().

Additional arguments can be passed in and will be passed to the subprocess.Popen() call. By default, a new console will be created for the subprocess.

Parameters:

• tuflowfv_bin (PathLike) – Path to the TUFLOW binary or a registered version name.

• add_cli_args (list[str]) – A list of additional command line arguments specific to TUFLOW that will be passed directly to the subprocess.Popen() call. e.g. add_cli_args=['-t'] to pass in the -t flag to run TUFLOW in test mode,

• *args – Will be passed to subprocess.Popen() call.

• **kwargs – Will be passed to subprocess.Popen() call.

Returns:

The subprocess.Popen object that is created when the control file is run.

Return type:

subprocess.Popen

Examples

>>> fvc = ... # assuming is an instance of FVC
>>> fvc.context().run('2026.0.1')