download_nek5000

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

Download 2D nek5000 data example.

Added in version 0.45.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('nek5000').paths.

Parameters:

loadbool, optional

Load the dataset after downloading it when True. Set this to False and only the filename will be returned. True requires vtk >= 9.3.

Returns:

outputpyvista.UnstructuredGrid | str

DataSet or filename depending on load.

Examples

Download Python source code | Download Jupyter notebook

>>> from pyvista import examples
>>> dataset = examples.download_nek5000()
>>> dataset.plot(scalars='Velocity', cpos='xy')

Static Scene

Interactive Scene

See Also

Nek5000 Dataset

See this dataset in the Dataset Gallery for more info.

Used In

Docstring Examples

• Nek5000Reader (1 use)