Metadata-Version: 2.4
Name: pyvista-quicklook
Version: 0.11.1
Summary: Quick Look previews for PyVista-readable mesh files.
Author: Erik Bedard
License-Expression: MIT
Project-URL: Documentation, https://pyvista.github.io/pyvista-quicklook/
Project-URL: Homepage, https://github.com/pyvista/pyvista-quicklook
Keywords: macos,mesh,preview,pyvista,quicklook,vtk
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: MacOS X
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: <3.15,>=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

<p align="center">
  <img src="https://raw.githubusercontent.com/pyvista/pyvista-quicklook/main/doc/_static/logo.png" alt="PyVista Quick Look" width="160">
</p>

# PyVista Quick Look

Press the space bar on a mesh file in the Finder and turn it with the mouse, the same
way macOS already previews `.ply` and `.obj` models. Over 80 formats PyVista reads are
claimed, each shown coloured by its active scalars with a panel of what the dataset holds
beside it.

![The Quick Look panel previewing flow.vtu, turned and zoomed with the mouse beside its dataset details](https://raw.githubusercontent.com/pyvista/pyvista-quicklook/main/doc/_static/quicklook.gif)

## Install

macOS 15 or newer. Nothing else needs to be installed first.

```bash
curl -LsSf https://github.com/pyvista/pyvista-quicklook/releases/latest/download/install.sh | sh
```

Then select a `.vtu`, `.vtp`, or `.vtk` file in the Finder and press space.

A preview is for a quick look, not for measuring: a large surface may be thinned and a
volume cut into slices, while the dataset panel describes the file itself.

## Documentation

**[pyvista.github.io/pyvista-quicklook](https://pyvista.github.io/pyvista-quicklook/)**

- [Install](https://pyvista.github.io/pyvista-quicklook/install.html): from PyPI, what the installer does and where things go, uninstall
- [Using the preview](https://pyvista.github.io/pyvista-quicklook/usage.html): turning the surface, the dataset panel, fast previews with pyvista-zstd
- [Settings](https://pyvista.github.io/pyvista-quicklook/settings.html): themes, every setting, native formats
- [Supported files](https://pyvista.github.io/pyvista-quicklook/formats.html): every claimed extension
- [How it works](https://pyvista.github.io/pyvista-quicklook/how-it-works.html): the render service, cache, large files
- [Troubleshooting](https://pyvista.github.io/pyvista-quicklook/troubleshooting.html) and [Commands](https://pyvista.github.io/pyvista-quicklook/commands.html)

Developing or releasing PyVista Quick Look is described in [CONTRIBUTING.md](CONTRIBUTING.md).
