README.md 3.23 KB
Newer Older
1
![VTK - The Visualization Toolkit][vtk-banner]
2
3
4
5
6
7

Introduction
============

VTK is an open-source software system for image processing, 3D
graphics, volume rendering and visualization. VTK includes many
T.J. Corona's avatar
T.J. Corona committed
8
advanced algorithms (e.g., surface reconstruction, implicit modeling,
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
decimation) and rendering techniques (e.g., hardware-accelerated
volume rendering, LOD control).

VTK is used by academicians for teaching and research; by government
research institutions such as Los Alamos National Lab in the US or
CINECA in Italy; and by many commercial firms who use VTK to build or
extend products.

The origin of VTK is with the textbook "The Visualization Toolkit, an
Object-Oriented Approach to 3D Graphics" originally published by
Prentice Hall and now published by Kitware, Inc. (Third Edition ISBN
1-930934-07-6). VTK has grown (since its initial release in 1994) to a
world-wide user base in the commercial, academic, and research
communities.

Learning Resources
==================

27
* General information is available at the [VTK Homepage][vtk-homepage].
28

29
* Community discussion takes place on the [VTK Discourse][vtk-discourse] forum.
30

31
32
* Commercial [support][kitware-support] and [training][kitware-training]
  are available from [Kitware][kitware].
33
34

* Doxygen-generated nightly reference documentation is
35
  available [online][vtk-doxygen].
36

37
38
39
* There is now a large collection of [VTK Examples][vtk-examples] that
  showcase VTK features and provide a useful learning resource.

40
41
42
43
44
Reporting Bugs
==============

If you have found a bug:

45
1. If you have a patch, please read the [CONTRIBUTING.md][vtk-contributing] document.
46

47
2. Otherwise, please join the [VTK Discourse][vtk-discourse] forum and ask
48
49
50
51
   about the expected and observed behaviors to determine if it is
   really a bug.

3. Finally, if the issue is not resolved by the above steps, open
52
   an entry in the [VTK Issue Tracker][vtk-issues].
53

54
55
56
57
58
Requirements
============

In general VTK tries to be as portable as possible; the specific configurations below are known to work and tested.

59
60
61
62
63
64
VTK supports the following compilers:

1. GCC 4.8 or newer
2. Clang 3.3 or newer
3. Apple Clang 5.0 (from Xcode 5.0) or newer
4. Microsoft Visual Studio 2015 or newer
65
5. Intel 14.0 or newer
66
67

VTK supports the following operating systems:
68

69
1. Windows Vista or newer
70
2. Mac OS X 10.7 or newer
71
72
3. Linux (ex: Ubuntu 12.04 or newer, Debian 4 or newer)

73
74
75
76
77
Building
========

See [build.md][vtk-build] (in Documentation/dev/) for build instructions.

78
79
80
Contributing
============

81
See [CONTRIBUTING.md][vtk-contributing] for instructions to contribute.
82

83
84
85
86
License
=======

VTK is distributed under the OSI-approved BSD 3-clause License.
87
88
89
90
91
92
93
See [Copyright.txt][vtk-copyright] for details.


[kitware]: https://www.kitware.com/
[kitware-support]: https://www.kitware.com/what-we-offer/#support
[kitware-training]: https://www.kitware.com/what-we-offer/#training
[vtk-banner]: vtkBanner.gif
94
[vtk-build]: Documentation/dev/build.md#building-vtk
95
96
97
98
[vtk-contributing]: CONTRIBUTING.md#contributing-to-vtk
[vtk-copyright]: Copyright.txt
[vtk-discourse]: https://discourse.vtk.org/
[vtk-doxygen]: https://www.vtk.org/doc/nightly/html
99
[vtk-examples]: https://kitware.github.io/vtk-examples/site/
100
[vtk-homepage]: https://www.vtk.org/
101
[vtk-issues]: https://gitlab.kitware.com/vtk/vtk/-/issues