Installation
************


Location of the source code
---------------------------

The source code for the **SAS** system may be optained from the svn
repository located at the University of Texas at Austin, McDonald
Observatory.  The machine does not have an anonymous download
mechanism and you will need an account on the machine in order to
obtain the software. Assumming that you do have an account the command
to get the software is

``svn checkout svn+ssh://<user>@ute2.as.utexas.edu/repos/sas/trunk``

At the HET the main directory for the source code and the operating
environment is ``/opt/het/hetdex``.

The executable files are typically installed in
``/opt/het/hetdex/bin``; the python packages are typically installed
in ``/opt/het/hetdex/lib/python2.7/site-packages``; configuration
files are typically found in ``/opt/het/hetdex/etc/conf``.

Required packages
-----------------

The **SAS** software requires the `Numpy <http://www.numpy.org>`_ and
and `Matplotlib <http://matplotlib.org>`_ python packages to support
operations. These packages may have additional dependencies as well.


Setting up your environment
---------------------------

Because the executables and libraries are not in one of the standard
system locations you will need to modify your environment in order to
let the operating system know where to find executables, libraries,
and configuration files.

Note that we have a local install of Python 2.7.  This was done because
the packages available from Redhat are all woefully behind the times.

If you use the bash shell, then you should include the following lines
in your .bashrc file. ::

  #
  # .bashrc setup for HetDex
  #

  #
  # location of third-party and hetdex software executables
  #
  export HETDEX_DIR=/opt/het/hetdex

  #
  # modify environment variables to gain access to the system
  #  (this is required to operate the software)
  #
  export PATH=$HETDEX_DIR/Python-2.7/bin:$HETDEX_DIR/bin:$PATH
  export PYTHONPATH=$HETDEX_DIR/lib/python2.7/site-packages
       :$HETDEX_DIR/lib64/python2.7/site-packages:$PYTHONPATH


If you use csh or tcsh, then include the following in your .cshrc file. ::

  #
  # .cshrc set up for HetDex
  #

  #
  # location of third-party and hetdex software executables
  #
  setenv HETDEX_DIR /opt/het/hetdex

  #
  # for third-party software locations
  #  (this is required to operate the software)
  #
  setenv PATH $HETDEX_DIR/Python-2.7/bin:$HETDEX_DIR/bin:$PATH
  setenv PYTHONPATH $HETDEX_DIR/lib/python2.7/site-packages
       :$HETDEX_DIR/lib64/python2.7/site-packages




Installing the modules and scripts
-----------------------------------------------

**SAS** is a pure python package and can be installed from the **SAS**
root directory with the command

  ``python setup.py install --prefix=$HETDEX_DIR``

This will install the module in $prefix/lib/python2.7/site-packages
and the scripts in $prefix/bin.  This normally done at Het as the user
hetdex.


Building the Documentation
--------------------------

The documentation is created through the `Sphinx
<http://www.sphinx-doc.org>`_ documentation system. The source files
are located in ``/doc/sas``.

You can run ``make`` to get a list of available target
formats. Normally the documentation can be built by running ``make
html latexpdf`` in the ``./doc`` directory. This will build the html
pages and the PDF version of the document. The PDF file will be in
``./_build/latex/HetPython.pdf`` while the
HTML files can be found in ``./_build/html``.  These files may be
installed in the directories of your choice.