Metadata-Version: 2.4
Name: finam_vtk
Version: 0.1.0
Summary: FINAM VTK I/O components.
Project-URL: Homepage, https://FINAM-VTK.pages.ufz.de/
Project-URL: Documentation, https://FINAM-VTK.pages.ufz.de/
Project-URL: Source, https://git.ufz.de/FINAM/finam-vtk
Project-URL: Tracker, https://git.ufz.de/FINAM/finam-vtk/-/issues
Project-URL: Changelog, https://git.ufz.de/FINAM/finam-vtk/-/blob/main/finam-vtk/CHANGELOG.md
Author-email: FINAM Developers <finam@ufz.de>
License-Expression: LGPL-3.0
License-File: AUTHORS.md
License-File: COPYING
License-File: COPYING.LESSER
License-File: LICENSE.md
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Requires-Dist: cftime
Requires-Dist: finam>=1.1.0
Requires-Dist: numpy>=1.14.5
Requires-Dist: pyvista>=0.40
Provides-Extra: doc
Requires-Dist: docutils>=0.18; extra == 'doc'
Requires-Dist: myst-parser>=1.0; extra == 'doc'
Requires-Dist: numpydoc>=1.1; extra == 'doc'
Requires-Dist: pydata-sphinx-theme<0.14,>=0.13; extra == 'doc'
Requires-Dist: sphinx-design>=0.4; extra == 'doc'
Requires-Dist: sphinx>=6; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest-cov>=3; extra == 'test'
Description-Content-Type: text/markdown

# finam-vtk

`finam-vtk` provides FINAM readers, writers, and helper utilities for working
with [VTK](https://vtk.org/) datasets through
[PyVista](https://pyvista.org/).

<a href="https://finam-vtk.pages.ufz.de/" title="FINAM VTK homepage" target="_blank">
  <img width="300" src="https://git.ufz.de/FINAM/finam-vtk/-/raw/main/docs/source/_static/logo_large.svg" />
</a>

## Available API

- Readers: `VTKStaticReader` for single datasets and `PVDReader` for PVD time
  series.
- Writers: `VTKStaticWriter`, `PVDTimedWriter`, and `PVDPushWriter` for
  callback-driven PVD series.
- Helpers: `DataArray`, `read_vtk_grid()`, `read_aux_file()`, and the
  `finam_vtk.tools` module.

## Installation

```bash
pip install finam-vtk
```

## Documentation

The full documentation is available at https://finam.pages.ufz.de/finam-vtk/.

The repository also contains small end-to-end examples in [`examples/`](examples).

## License

LGPLv3, Copyright © 2021-2026, the FINAM developers from Helmholtz-Zentrum für Umweltforschung GmbH - UFZ. All rights reserved.
