INSTALL.txt

Building and installing PySpectrograph
+++++++++++++++++++++++++++++

See http://code.google.com/p/pyspectrograph/
for updates of this document.

.. Contents::

INTRODUCTION
============

These installation instructions have only been tested on Mac OSX and Ubuntu 
Linux.  For the prerequisites, the software has been tested at these version of 
the software to work, but it may operate at earlier versions that have not been
tested.

PREREQUISITES
=============

PySpectrograph requires the following software installed for your platform:

1) Python__ 2.5.x or newer

__ http://www.python.org

2) NumPy__ 1.4.1 or newer 

__ http://www.numpy.org/

3) SciPy__ 0.8.0 or newer

__ http://www.scipy.org/

4) PyFits__ 1.3 or newer

__ http://www.stsci.edu/resources/software_hardware/pyfits

5) Matplotlib__ 1.0 or newer

__ http://matplotlib.sourceforge.net/


GETTING PySpectrograph
======================

For the latest information, see the web site:

  http://code.google.com/p/pyspectrograph/

Download the current stable version (Download):
-----------------------------------------------

   http://code.google.com/p/pyspectrograph/

Development version from Subversion (SVN)
-----------------------------------------
Use the command::

  svn checkout http://pyspectrograph.googlecode.com/svn/trunk/ pyspectrograph-read-only

Then type::

  cd pyspectrograph
  rm -rf build
  python setup.py install
 
INSTALLATION
============

First make sure that all PySpectrograph prerequisites are installed and working
properly.  

From tarballs
-------------
Unpack ``PySpectrograph-<version>.tar.gz``, change to the ``PySpectrograph-<version>/``
directory, and run
::

  python setup.py install

You may need to be root in order to this and if so, make sure that the root python
will install the package in the same directory as the user python. 
To install to a user-specific location instead, run::

  python setup.py install --prefix=$MYDIR

where $MYDIR is, for example, $HOME or $HOME/usr.

        ** Note 1: On Unix, you should avoid installing in /usr, but rather in
        /usr/local or somewhere else. /usr is generally 'owned' by your package
        manager, and you may overwrite a packaged PySpectrograph this way.

TESTING
=======

There are no tests currently available with this release, but you should be able 
to import the package after installation.

KNOWN INSTALLATION PROBLEMS
===========================

Currently None.

TROUBLESHOOTING
===============

If you experience problems when building/installing/testing PySpectrograph,
please ask help from crawfordsm@gmail.com.