download_prostar

download_prostar(load: bool = True) → UnstructuredGrid | str

Download a prostar dataset.

Added in version 0.44.0.

Note

load=False returns only the file which is read directly, not the other files downloaded alongside it. This is a legacy quirk of the load argument. For every file belonging to this example, use examples.get_example('prostar').paths.

Parameters:

loadbool, default: True

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

Returns:

outputpyvista.UnstructuredGrid | str

DataSet or filename depending on load.

Examples

Download Python source code | Download Jupyter notebook

>>> from pyvista import examples
>>> mesh = examples.download_prostar()
>>> mesh.plot()

Static Scene

Interactive Scene

See Also

Prostar Dataset

See this dataset in the Dataset Gallery for more info.

Used In

Docstring Examples

• DataSet.max_cell_dimensionality (1 use)
• ProStarReader (1 use)