manual/intro.rst

   1
   2 .. _intro:
   3
   4 ************
   5 Introduction
   6 ************
   7
   8 PyX is a Python package for the creation of vector graphics. As such it readily
   9 allows one to generate encapsulated PostScript files by providing an abstraction
  10 of the PostScript graphics model.  Based on this layer and in combination with
  11 the full power of the Python language itself, the user can just code any
  12 complexity of the figure wanted. PyX distinguishes itself from other similar
  13 solutions by its TeX/LaTeX interface that enables one to make direct use of the
  14 famous high quality typesetting of these programs.
  15
  16 A major part of PyX on top of the already described basis is the provision of
  17 high level functionality for complex tasks like 2d plots in publication-ready
  18 quality.
  19
  20
  21 Organisation of the PyX package
  22 ===============================
  23
  24 The PyX package is split into several modules, which can be categorised in the
  25 following groups
  26
  27 +----------------------------------+------------------------------------------+
  28 | Functionality                    | Modules                                  |
  29 +==================================+==========================================+
  30 | basic graphics functionality     | :mod:`canvas`, :mod:`path`, :mod:`deco`, |
  31 |                                  | :mod:`style`, :mod:`color`, and          |
  32 |                                  | :mod:`connector`                         |
  33 +----------------------------------+------------------------------------------+
  34 | text output via TeX/LaTeX        | :mod:`text` and :mod:`box`               |
  35 +----------------------------------+------------------------------------------+
  36 | linear transformations and units | :mod:`trafo` and :mod:`unit`             |
  37 +----------------------------------+------------------------------------------+
  38 | graph plotting functionality     | :mod:`graph` (including submodules) and  |
  39 |                                  | :mod:`graph.axis` (including submodules) |
  40 +----------------------------------+------------------------------------------+
  41 | EPS file inclusion               | :mod:`epsfile`                           |
  42 +----------------------------------+------------------------------------------+
  43
  44 These modules (and some other less import ones) are imported into the module
  45 namespace by using   ::
  46
  47    from pyx import *
  48
  49 at the beginning of the Python program.  However, in order to prevent namespace
  50 pollution, you may also simply use ``import pyx``. Throughout this manual, we
  51 shall always assume the presence of the above given import line.
  52