File: index.rst

package info (click to toggle)
python-vispy 0.16.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,112 kB
  • sloc: python: 61,648; javascript: 6,800; ansic: 2,104; makefile: 141; sh: 6
file content (44 lines) | stat: -rw-r--r-- 1,716 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
Getting Started
===============

VisPy strives to provide an easy path for users to make fast interactive
visualizations. To serve as many users as possible VisPy provides different
interfaces for differing levels of experience. While one interface may be
enough to build a simple visualization, knowing all the interfaces can provide
the most flexibility for fully customizing your visualization.

The below pages are meant to provide an introduction to these interfaces and
help guide you into what interface might be best for your experience and the
final visualization you are looking to achieve. Additionally, the
:doc:`../gallery/index` can be used for inspiration. Further low-level details can
be found in the :doc:`API documentation <../api/modules>` and existing
examples.

VisPy targets two primary categories of users:

1. **Users knowing OpenGL**, or willing to learn OpenGL, who want to
   create beautiful and fast interactive 2D/3D visualizations in Python
   as easily as possible. Users in this category can write their own
   visualizations with :mod:`vispy.gloo` (requires knowing OpenGL/GLSL).
   Another option with VisPy development is to encapsulate gloo-based
   visualizations into re-usable `Visual` classes. The below pages will
   provide an introduction of these interfaces.

.. toctree::
  :maxdepth: 1

  modern-gl
  Gloo <gloo>
  Visuals <visuals>

2. **Scientists without any knowledge of OpenGL**, who are seeking a
   high-level, high-performance plotting toolkit. Use the :mod:`vispy.plot`
   and :mod:`vispy.scene` interfaces for high-level work. The below pages
   provide an introduction into these interfaces.

.. toctree::
  :maxdepth: 1

  Scene <scene>
  Plotting <plot>