py2vtk 1.0

Low dependency module to export to VTK from python

# Py2VTK

[](https://github.com/psf/black) [](https://github.com/anlavandier/py2vtk/actions?query=workflow%3Atests) [](https://py2vtk.readthedocs.io/en/latest/?badge=latest)

Py2VTK is a low dependency module for exporting VTK files using Python for visualization/analysis in softwares like Paraview, VisIt or Mayavi.

## Acknowledgments

Py2vtk borrows heavily from [PyEVTK](https://github.com/pyscience-projects/pyevtk) and [UVW](https://github.com/prs513rosewood/uvw).

## Current state

Py2vtk is still in development. Current and future features are listed below in no particular order:

### Current and planned features

• [x] Setting up github actions powered CI

• [x] Finalization of a first “release” to make available via Pypi and Spack. (Pypi completed, Spack on hold until further notice).

• [x] Recreation of PyEvtk’s API

• [x] Parallel API using mpi4py.

• [ ] Support of Dask Arrays (Not started yet).

• [x] Add documentation using docstrings and [sphinx](https://www.sphinx-doc.org/en/master/).

## Installation

This package is hosted in Pypi and can be installed with pip. There is currently 3 installation modes:

• Standard install (does not feature the MPI-enabled API)

  `bash python -m pip install py2vtk `

• MPI Install

  `bash python -m pip install py2vtk[mpi] `

• Test install, needed to run the unit tests locally

  `bash python -m pip install py2vtk[tests] `

## Running tests

To run the unit tests locally, use the following commands

`bash py.test -m serial # Serial tests python mpi_tester.py . -m parallel # Parallel tests `