Python interface for VTK
Branch: master
Clone or download
Latest commit 7f389c7 Feb 15, 2019

README.rst

vtki

https://img.shields.io/pypi/v/vtki.svg?logo=python&logoColor=white https://img.shields.io/travis/akaszynski/vtki/master.svg?label=build&logo=travis https://img.shields.io/appveyor/ci/akaszynski/vtkinterface.svg?label=AppVeyor&style=flat&logo=appveyor https://img.shields.io/readthedocs/vtkinterface.svg?logo=read%20the%20docs&logoColor=white https://img.shields.io/github/contributors/akaszynski/vtki.svg?logo=github&logoColor=white

vtki is a VTK helper module that takes a different approach on interfacing with VTK through NumPy and direct array access. This module simplifies mesh creation and plotting by adding functionality to existing VTK objects.

This module can be used for scientific plotting for presentations and research papers as well as a supporting module for other mesh dependent Python modules.

Documentation

Refer to the Read the Docs documentation for detailed installation and usage details.

Also see the wiki for brief code snippets.

Installation

Installation is simply:

pip install vtki

You can also visit PyPi or GitHub to download the source.

See the Installation for more details if the installation through pip doesn't work out.

Highlights

Head over to the Quick Examples page in the docs to learn more about using vtki.

  • Pythonic interface to VTK's Python-C++ bindings
  • Filtering/plotting tools built for interactivity in Jupyter notebooks (see IPython Tools)
  • Direct access to common VTK filters (see Filters)
  • Intuitive plotting routines with matplotlib similar syntax (see Plotting)

Connections

vtki is a powerful tool that researchers can harness to create compelling, integrated visualizations of large datasets in an intuitive, Pythonic manner. Here are a few open-source projects that leverage vtki:

  • pyansys: Pythonic interface to ANSYS result, full, and archive files
  • PVGeo: Python package of VTK-based algorithms to analyze geoscientific data and models. vtki is used to make the inputs and outputs of PVGeo's algorithms more accessible.
  • omfvtk: 3D visualization for the Open Mining Format (omf). vtki provides the foundation for this libraries visualization.
  • discretize: Discretization tools for finite volume and inverse problems. discretize provides toVTK methods that return vtki versions of their data types for creating compelling visualizations.
  • pymeshfix: Python/Cython wrapper of Marco Attene's wonderful, award-winning MeshFix software.
  • tetgen: Python Interface to Hang Si's C++ TetGen Library