download_test_examples

ansys.meshing.prime.examples.download_test_examples(destination=None, force=False)

Download the example files necessary for unit testing.

Parameters:

destinationstr, optional

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

forcebool, optional

Whether to always download the test example files. The default is False, in which case if the test example files are cached, they are reused.

Returns:

List[str]

Local paths to the downloaded test example files.

Return type:

Union[str, PathLike]

Examples

>>> import ansys.meshing.prime as prime
>>> import ansys.meshing.prime.examples as prime_examples
>>> with prime.launch_prime() as session:
>>>     model = session.model
>>>     examples = prime_examples.unit_test_examples.download_test_examples()