Skip to content

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

License

Notifications You must be signed in to change notification settings

anlavandier/py2vtk

Repository files navigation

Py2VTK

Code style: black CI Documentation Status

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 and UVW.

Current state

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

Current and planned features

  • Setting up github actions powered CI
  • Finalization of a first "release" to make available via Pypi and Spack. (Pypi completed, Spack on hold until further notice).
  • Recreation of PyEvtk's API
  • Parallel API using mpi4py.
  • Support of Dask Arrays (Not started yet).
  • Add documentation using docstrings and sphinx.

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)

    python -m pip install py2vtk
  • MPI Install

    python -m pip install py2vtk[mpi]
  • Test install, needed to run the unit tests locally

    python -m pip install py2vtk[tests]

Running tests

To run the unit tests locally, use the following commands

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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages