vtki Documentation

https://img.shields.io/pypi/v/vtki.svg?logo=python&logoColor=white https://img.shields.io/travis/vtkiorg/vtki/master.svg?label=build&logo=travis https://img.shields.io/appveyor/ci/banesullivan/vtki.svg?label=AppVeyor&style=flat&logo=appveyor https://img.shields.io/github/contributors/vtkiorg/vtki.svg?logo=github&logoColor=white https://codecov.io/gh/akaszynski/vtki/branch/master/graph/badge.svg https://api.codacy.com/project/badge/Grade/e927f0afec7e4b51aeb7785847d0fd47 GitHub

About

vtki is a helper module for the Visualization Toolkit (VTK) 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.

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 library’s 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

Getting Started

If you have a working copy of VTK, installation is simply:

$ pip install vtki

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

See Installation for more details.

Data Types

The Visualization Toolkit (VTK), developed by Kitware, has many mesh data types that vtki wraps. This chapter is intended to describe these different mesh types on the VTK side to help new users understand which data types to use.

Examples

Be sure to head over to the Quick Examples chapter to explore different use cases of vtki and to start visualizing 3D data in Pyhton!

Tools

  • 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)

Project Index