API Reference

API reference for pyvista-zstd.

Convenience Functions

pyvista-zstd exposes three convenience functions to easily read and write compressed datasets using Zstandard

pyvista_zstd.read() and pyvista_zstd.write() work on files. A container that is already in memory, rather than on disk, is read with pyvista_zstd.read_buffer().

pyvista_zstd.read(filename[, n_threads, backend])	Decompress a pyvista-zstd file.
pyvista_zstd.read_buffer(data[, n_threads])	Decompress a pyvista-zstd container already held in memory.
pyvista_zstd.write(ds, filename, *[, ...])	Compress a PyVista or VTK dataset.

Classes

pyvista-zstd also exposes two classes to fine tune how datasets are read and written. For example, using the pyvista_zstd.Reader, you can select the arrays you wish to read in or even progressively read in individual datasets from a pyvista.MultiBlock.

pyvista_zstd.Reader([filename, buffer, backend])	Class to control pyvista-zstd file decompression.
pyvista_zstd.Writer(ds, filename)	Class to write a pyvista-zstd file.