API Reference

API Reference#

API reference for zvtk.

Convenience Functions#

zvtk exposes two convenience functions to easily read and write compressed datasets to disk using Zstandard

zvtk.read(filename[, n_threads])

Decompress a zvtk file.

zvtk.write(ds, filename, *[, progress_bar, ...])

Compress a PyVista or VTK dataset.

Classes#

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

zvtk.Reader(filename)

Class to control zvtk file decompression.

zvtk.Writer(ds, filename)

Class to write a zvtk file.
Contents