pytuflow.register_tuflow_binary_folder

register_tuflow_binary_folder(folder)

Register a directory containing TUFLOW releases. The directory should contain subdirectories (folders) named after the TUFLOW version and each subdirectory should contain the TUFLOW binaries (i.e. no further subdirectories should be present). The directory names are used as the registered version name and the available binaries are refreshed each time a TUFLOW binary is requested (i.e. a simulation is run).

It is best if this directory is a local directory and not a network drive. Binaries registered via register_tuflow_binary are given priority over binaries found using this method.

Parameters:

folder (PathLike) – Directory containing TUFLOW binaries

Return type:

None