FINAM VTK#

VTK reader and writer components for the FINAM model coupling framework.

Quickstart#

Installation:

pip install finam-vtk

For available components, see the api/index.

Usage#

See the example scripts in the GitLab repository for fully functional usage examples.

Readers#

The package provides two types of VTK reader components:

VTKStaticReader for reading starting conditions during initialization
PVDReader for reading time series of rasters

Both components can read multiple variables from a single dataset.

`VTKStaticReader`#

Reads once during initialization of the coupling setup. A time slice must be provided if the variable is actually temporal.

from finam_vtk import VTKStaticReader
from datetime import datetime

path = "tests/data/head.vtu"
reader = VTKStaticReader(path, reference_date=datetime(2024, 5, 1), time_unit="seconds")

`PVDReader`#

Reads once on each time step, where time steps are defined in the PVD file. Timepoints are calculated by the given reference date and a time unit.

from finam_vtk import PVDReader

path = "tests/data/head.pvd"
reader = PVDReader(path, time)

When multiple variables/layers are read, they must all use the same time dimension (i.e. they must have common time steps).

Outputs#

Component outputs can be accessed by the keys used for outputs, e.g. for linking:

reader.outputs["lai"] >> viewer.inputs["Grid"]

Writers#

The package provides two types of VTK writer components:

VTKTimedWriter for writing in predefined, fixed time intervals
VTKPushWriter for writing whenever new data becomes available

Both components can write multiple variables to a single dataset.

`VTKTimedWriter`#

Writes time slices regularly, irrespective of input time steps.

from datetime import timedelta
from finam_vtk import VTKTimedWriter

path = "tests/data/out.nc"
reader = VTKTimedWriter(path, ["lai"], step=timedelta(days=1))

`VTKPushWriter`#

Writes time slices as soon as new data becomes available to the inputs. Note that all input data sources must have the same time step!

from finam_vtk import VTKPushWriter

path = "tests/data/out.nc"
reader = VTKPushWriter(path, ["lai"])

API References#

Information about the API of FINAM-VTK.

API reference

About#

Further information about licensing, the developers team and the changelog of FINAM-VTK.

About