=================
Installing PyVib2
=================

The program can be installed either using the neutral Python distribution
utilities (Distutils) or in a platform specific way.

    * :ref:`Platform neutral way <platform_neutral>`
    * :ref:`Mac OS X <macosx>`
    * :ref:`Windows <windows>`
    * :ref:`Debian and derivatives <debian>`

Either way you choose, a few
:ref:`optional utilities <optional_utilities>` have to be installed separately.
These are necessary to create animations of vibrations.

.. warning::

    As of version 2.0, the program will **not** run with Python earlier
    than **2.5**.
.. note::

    Administrator privileges are necessary to perform system-wide
    installations.


.. _platform_neutral:
    
Platform neutral way
====================

The program will not work unless the following dependencies are met:

    #. `Python Megawidgets <http://sourceforge.net/projects/pmw>`_ 1.2+
            a library for a flexible GUI building, based on Tkinter.

    #. `numpy <http://sourceforge.net/projects/numpy>`_ 1.1+
            the fundamental package for scientific computing.

    #. `VTK <http://vtk.org/>`_ 5.0+
            Visualization ToolKit, a high-level 3D rendering library.

    #. `Matplotlib <http://sourceforge.net/projects/matplotlib>`_ 0.98+
            a 2D plotting library for producing publication quality figures.

To test whether these installations have been successful,
please execute in a Python shell::

     >>> import Pmw
     >>> import numpy
     >>> import vtk
     >>> import vtk.tk.vtkTkRenderWidget
     >>> import matplotlib

And finally, install the program itself. To be concrete, the instructions
below are meant for a \*nix/Linux shell:
        
    * Unpack the installation archive::

        # tar xvfz pyvib2-2.0.tar.gz

    * Change to the installation directory::

        # cd pyvib2-2.0

    * Run the setup script (Python magic spell)::

        # python setup.py install

To start the program::

    $ pyvib2


.. _macosx:

Mac OS X
========

An "all-in-one" archive for Intel is available for Mac OS X users, all the
dependencies are included into that archive and no additional
installations are necessary.

    * Unpack :file:`pyvib2-2.0_mac.zip` (Safari *usually* does it automatically)
    * Start :command:`PyVib2` from the :file:`pyvib2-2.0_mac` subdirectory

.. note::

    This version has been "frozen" on Mac OS X 10.5.7
    with `py2app <http://svn.pythonmac.org/py2app/py2app/trunk/doc/index.html>`_.


.. _windows:

Windows
=======    

Windows users can also use an "all-in-one" archive as for Mac OS X.

    * Unpack the :file:`pyvib2-2.0_win32.zip` archive (e.g. with
      `WinZip <http://winzip.com/>`_ or `WinRAR <http://winrar.com/>`_)
    * Start :command:`pyvib2.exe` from the :file:`pyvib2-2.0_win32` subdirectory

.. note::

    This version has been "frozen" on Windows XP with
    `py2exe <http://www.py2exe.org/>`_.

.. _debian:

Debian and derivatives
======================

The installation is performed with the Debian package manager
(:command:`dpkg`)::

    # dpkg --install pyvib2_2.0_all.deb

If there are any unresolved dependencies, use :command:`apt-get`
to satify them::
    
    # apt-get update && apt-get -f install

To start the program::

    $ pyvib2


.. _optional_utilities:

Optional utilities
==================

PyVib2 enables the user to create animations of vibrations in the Animated GIF
and FLI format. Windows user should read :doc:`this <hints_tricks>`.

#. Animated GIF format

    * `Netpbm <http://sourceforge.net/projects/netpbm>`_
        graphics tools and converters. 
    * `Gifsicle <http://www.lcdf.org/gifsicle/>`_
        a Unix command-line tool for creating, editing,
        and getting information about GIF images and animations.

#. FLI format
        
    * `ppm2fli <http://vento.pi.tu-berlin.de/ppm2fli/main.html>`_
        producing FLI animation files. 

The `ps2pdf <http://www.ps2pdf.com/>`_ program is required for saving PDF files.