download_file

DownloadManager.download_file(filename, *directory, destination=None, force=False)

Download an example file from the PyPrimeMesh repository.

Parameters:

filenamestr

Name of the example file to download.

destinationstr, optional

Path to download the example file to. The default is None, in which case the default path for app data is used.

forcebool, optional

Whether to always download the example file. The default is False, in which case if the example file is cached, it is reused.

directorytuple[str]

Path under the PyAnsys Github examples repository.

Returns:

tuple[str, str]

Tuple containing the filepath to use and the local filepath of the downloaded directory. The two are different in case of containers.

Return type:

str