INSTALL

   1 Installation
   2 ============
   3
   4
   5 Prerequisites
   6 -------------
   7
   8 PyX requires Python 3.2 or newer and a TeX installation (including Type1 fonts).
   9 Try to start 'python', 'tex' and 'kpsewhich cmr10.pfb' (the latter should issue
  10 a full path of the requested Type1 font).
  11
  12
  13 Local usage without C extension modules
  14 ---------------------------------------
  15
  16 PyX can be run without any installation. To test your environment copy the file
  17 hello.py from the examples directory to the main pyx directory (where the
  18 subdirectory pyx containing the modules is located) and type 'python hello.py'.
  19 For debugging, you can call the pyxinfo() method immediately after the import to
  20 get some details written to stderr.
  21
  22
  23 Installation procedure
  24 ----------------------
  25
  26 The installation of PyX is pretty straightforward if you have installed the
  27 Python distutils package.
  28
  29 First, you have to decide which C extension modules you want to build. This can
  30 be done by setting the respective flags in the setup.cfg config file. By default
  31 no C extension modules are built and appropriate fallbacks will be used instead.
  32
  33 The build_t1code option enables building of an extension module, which enables
  34 faster coding/decoding of Type 1 fonts. The only requisites for building this
  35 module are the Python header files and a C compiler. Note that the C compiler
  36 has to suit the Python distribution you are using.
  37
  38 The second extension module pykpathsea provides Python binding for the kpathsea
  39 library, which enables fast searching for files in the TeX/LaTeX directory
  40 hierarchy. You will need the header files of this library, which unfortunately
  41 are not included in many standard TeX distributions. Note that the fallback,
  42 which uses the kpsewhich program, works equally well, although it is not as
  43 efficient as using the library directly. If you want to build the C extension
  44 module, you may also have to specify the location of the kpathsea header files
  45 and of the library itself in the setup.cfg file.
  46
  47 After you have adapted the setup.cfg file to your needs, you can either build
  48 the extension modules locally by running
  49
  50     python setup.py build_ext -i
  51
  52 or install PyX system wide by using
  53
  54     python setup.py install
  55
  56 or an appropriate variant thereof.
  57
  58
  59 Installation by easy_install or pip
  60 -----------------------------------
  61
  62 PyX can be installed via easy_install and pip straightforwardly. It can be run
  63 as an zipped egg. Note that you need to allow the installation of externally
  64 hosted files. Thus you probably need to add "--allow-external pyx" in future
  65 versions of pip.