fix call signature
[PyX/mjg.git] / README
blob7fc89f141407eb9a53bb34cca0c2ef5a800ac3d0
1                       PyX - Python graphics package
2                       =============================
4 PyX is a Python package to create encapsulated PostScript figures. It provides
5 classes and methods to access basic PostScript functionality at an abstract
6 level. At the same time the emerging structures are very convenient to produce
7 all kinds of drawings in a non-interactive way. In combination with the Python
8 language itself the user can just code any complexity of the figure wanted.
9 Additionally an TeX/LaTeX interface enables one to use the famous high quality
10 typesetting within the figures.
12 A major part of PyX on top of the already described basis is the provision of
13 high level functionality for complex tasks like 2d plots in publication-ready
14 quality.
16 Installation
17 ------------
19 The installation of PyX is described in the file INSTALL.
21 Documentation
22 -------------
24 A prebuilt version of the manual is distributed in manual/manual.pdf. For
25 answers to frequently asked questions, we refer to pyx/pyxfaq.pdf. We also
26 recommend taking a look on the nice examples for the use of PyX, which can be
27 found in the examples directory.
29 License
30 -------
32 PyX is free software; you can redistribute it and/or modify
33 it under the terms of the GNU General Public License as published by
34 the Free Software Foundation; either version 2 of the License, or
35 (at your option) any later version.
37 PyX is distributed in the hope that it will be useful,
38 but WITHOUT ANY WARRANTY; without even the implied warranty of
39 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
40 GNU General Public License for more details.
42 You should have received a copy of the GNU General Public License
43 along with PyX; if not, write to the Free Software
44 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA