API Reference

API Reference#

API reference for pyvista-zstd.

Convenience Functions#

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

pyvista_zstd.read(filename[, n_threads])

Decompress a pyvista-zstd file.

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)

Class to control pyvista-zstd file decompression.

pyvista_zstd.Writer(ds, filename)

Class to write a pyvista-zstd file.