README.md 3.42 KB
Newer Older
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
1
![ParaView](Documentation/img/paraview.png)
2
3
4

Introduction
============
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
5
6
[ParaView][] is an open-source, multi-platform data analysis and
visualization application based on
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
7
[Visualization Toolkit (VTK)][VTK].
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
8
9

The first public release was announced in October 2002. Since then, the project
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
10
11
12
13
has grown through collaborative efforts between [Kitware Inc.][Kitware],
[Sandia National Laboratories][Sandia],
[Los Alamos National Laboratory][LANL],
[Army Research Laboratory][ARL], and various other
14
government and commercial institutions, and academic partners.
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
15
16
17
18
19
20
21

[ParaView]: http://www.paraview.org
[VTK]: http://www.vtk.org
[Kitware]: http://www.kitware.com
[Sandia]: http://www.sandia.gov/
[LANL]: http://www.lanl.gov/
[ARL]: http://www.arl.army.mil/
22
23
24
25
26
27

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

* General information is available at the [ParaView Homepage][].

Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
28
* [The ParaView Guide][Guide] can be downloaded (as PDF) or purchased (in print).
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
29

30
* Community discussion takes place on the [ParaView Discourse][] forum.
31
32
33
34

* Commercial [support][Kitware Support] and [training][Kitware Training]
  are available from [Kitware][].

35
36
* Additional documentation, including Doxygen-generated nightly
  reference documentation, is available [online][Documentation].
37
38
39

[ParaView Homepage]: http://www.paraview.org
[Documentation]: http://www.paraview.org/documentation/
40
[ParaView Discourse]: https://discourse.paraview.org/
41
42
43
[Kitware]: http://www.kitware.com/
[Kitware Support]: http://www.kitware.com/products/support.html
[Kitware Training]: http://www.kitware.com/products/protraining.php
Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
44
[Guide]: http://www.paraview.org/paraview-guide/
45

46
47
48
49

Building
========

50
51
There are two ways to build ParaView:

52
53
54
* The easiest method for begginners to build ParaView from source is
by using our [Getting Started compilation guide][build] which includes
commands to install the needed dependencies for most operating systems.
55

56
57
58
59
* Another way to build ParaView, quite useful when trying to enable more specific
options which requires to build dependencies yourself (ie osmesa, raytracing),
would be the [ParaView Superbuild][sbrepo]. The superbuild downloads and builds all
of ParaView's dependencies as well as ParaView itself.
60
61

[sbrepo]: https://gitlab.kitware.com/paraview/paraview-superbuild
62
[build]: Documentation/dev/build.md
63

64
65
66
67
68
Reporting Bugs
==============

If you have found a bug:

69
1. If you have a source-code fix, please read the [CONTRIBUTING.md][] document.
70

71
72
2. Otherwise, please join the [ParaView Discourse][] forum and ask about
   the expected and observed behaviors to determine if it is really a bug.
73
74
75
76

3. Finally, if the issue is not resolved by the above steps, open
   an entry in the [ParaView Issue Tracker][].

77
[ParaView Issue Tracker]: https://gitlab.kitware.com/paraview/paraview/-/issues
78

79
80
81
82
83
Contributing
============

See [CONTRIBUTING.md][] for instructions to contribute.

Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
84
85
86
87
88
89
90
91
92
For Github users
----------------

[Github][] is a mirror of the [official repository][repo]. We do not actively monitor issues or
pull requests on Github. Please use the [official repository][repo] to report issues or contribute
fixes.

[Github]: https://github.com/Kitware/ParaView
[repo]: https://gitlab.kitware.com/paraview/paraview
93
94
[CONTRIBUTING.md]: CONTRIBUTING.md

95
96
97
98
99
100
101
102
License
=======

ParaView is distributed under the OSI-approved BSD 3-clause License.
See [Copyright.txt][] for details. For additional licenses, refer to
[ParaView Licenses][].

[Copyright.txt]: Copyright.txt
103
[ParaView Licenses]: http://www.paraview.org/paraview-license/