pyvista.examples.downloads.download_particles_lethe

pyvista.examples.downloads.download_particles_lethe#

download_particles_lethe(load=True)[source]#

Download a particles dataset generated by lethe .

See PyVista discussions #1984

Parameters:
loadbool, default: True

Load the dataset after downloading it when True. Set this to False and only the filename will be returned.

Returns:
pyvista.UnstructuredGrid | str

DataSet or filename depending on load.

Examples

Download the particles dataset and plot it after generating glyphs.

>>> from pyvista import examples
>>> particles = examples.download_particles_lethe()
>>> particles.plot(
...     render_points_as_spheres=True,
...     style='points',
...     scalars='Velocity',
...     background='w',
...     scalar_bar_args={'color': 'k'},
...     cmap='bwr',
... )
../../../_images/pyvista-examples-downloads-download_particles_lethe-1_00_00.png

See also

Particles Lethe Dataset

See this dataset in the Dataset Gallery for more info.