API reference

All objects below are part of the public finam_vtk import surface.

Readers

VTKStaticReader(path[, outputs, grid_arguments])	VTK reader component that reads a single 2D data array per output at startup.
PVDReader(path, reference_date, time_unit[, ...])	VTK reader component that steps along a date/time coordinate dimension of a dataset.

Writers

VTKStaticWriter(path, inputs[, legacy, binary])	VTK writer component for static inputs.
PVDTimedWriter(path, inputs, step[, ...])	PVD writer component that writes in predefined time intervals.
PVDPushWriter(path, inputs[, time_unit, ...])	PVD writer component that writes on push to its inputs.

Helpers

DataArray(name[, association])	Specifications for a VTK data array.
read_vtk_grid(path[, remove_low_dim_cells, ...])	Read a finam grid from a VTK file.
read_aux_file(file_path)	Load a dictionary from a JSON file and convert 'reference_date' strings back to datetime objects.
tools	VTK helper classes and functions