download_file

download_file#

download_file(filename: str) → str | list[str][source]#

Download a single file from the pyvista/data repository.

You can add an example file at pyvista/data.

Parameters:

Returns:

outputstr | list: A single path if the file is not an archive. A list of paths if the file is an archive.

Download the 'puppy.jpg' image.

>>> from pyvista import examples
>>> path = examples.download_file('puppy.jpg')
>>> path
'/home/user/.cache/pyvista_3/puppy.jpg'

Docstring Examples

Gallery Examples

Adding a New Gallery Example

1 use

1 use