INSTALL

INSTALL - pyaccel
=================

This package can be installed using setuptools (>=16.0). There is no automatic
dependency checking, so read the list below and ensure necessary dependencies
are available. Developed and tested with Python 3 (3.4).


REQUIREMENTS
============

- trackcpp C++/Python package 3.3 (>=3.3.0)
- numpy 1.8 (>=1.8.2)
- mathphys 0.7 (>=0.7.0)
- matplotlib 1.4 (>=1.4.2) [Optional for graphics and interactive modules]


INSTALLATION
============

To install to a default Python directory, run

    <python> setup.py install

Use the appropriate command in <python>. Depending on permissions, it may be
necessary to run the command with sudo or as superuser.

To install a development version, with a link to the local package files in the
default Python directory, run

    <python> setup.py develop

Details and further options can be found in setuptools documentation.