*****************************************************************
* CIAO Contributed Scripts README				*
*****************************************************************

----------
DISCLAIMER
----------

THESE SCRIPTS ARE NOT PART OF CIAO.  THEY ARE PROVIDED "AS IS",
AND THE CHANDRA X-RAY CENTER IS UNDER NO OBLIGATION TO SUPPORT
THEM.  THE USER ASSUMES ALL RESPONSIBILITY FOR THE RESULTS
OBTAINED BY USING THESE SCRIPTS.

Although the CXC does not officially support these scripts, we
do try to keep them up-to-date and bug-free.  Updates are posted
on the scripts download page: 
http://cxc.harvard.edu/ciao/download/scripts/


--------------------------
CIAO VERSION COMPATIBILITY
--------------------------

This scripts package is designed for use with CIAO 4.1 or
later. Refer to the individual script ahelp files for software version
and calibration requirements.


------------
INSTALLATION
------------

Overview
========

The CIAO_scripts.tar file is a tar archive that is designed to be
unpacked in $ASCDS_INSTALL, the root directory of the CIAO 
installation.  If you do not have write permission in 
$ASCDS_INSTALL, you will need to ask your system administrator to
install these scripts.

The tarball unpacks into the "contrib" subdirectory of $ASCDS_INSTALL.
Within $ASCDS_INSTALL/contrib, the script files are distributed among
several subdirectories.  (If $ASCDS_INSTALL/contrib or any of its
subdirectories do not exist, tar will create them.)  The directories
and their associated contents are as follows:

$ASCDS_INSTALL/contrib/bin
    Executable scripts

$ASCDS_INSTALL/share/slsh/local-packages/
    S-Lang scripts and functions

$ASCDS_INSTALL/contrib/doc/xml
    XML documentation files for individual scripts, viewable in 
    the CIAO ahelp system

$ASCDS_INSTALL/contrib/param
    Parameter files for scripts with parameter interfaces


Instructions
============

1) Start CIAO

   The installation instructions are given relative to the CIAO
   environment variable $ASCDS_INSTALL.  You need to be in a window
   running CIAO so that this variable is defined.


2) Uninstall old scripts

   It is advisable to clear out any existing scripts before installing
   the new tarfile.  The uninstall script is included in the script
   tarfile, so you should find it in the $ASCDS_CONTRIB directory. 

   Make sure the script is executable, and then run it:

     unix% cd $ASCDS_INSTALL/contrib
     unix% chmod +x uninstall_CIAO4.1_scripts
     unix% ./uninstall_CIAO4.1_scripts

   The uninstall script contains a list of the specific script files
   to remove, along with the parameter files and documentation.  No
   other files in your CIAO distribution can be deleted by this
   script. 


3) Unpack the tarball

     unix% cp CIAO_4.1_scripts.tar $ASCDS_INSTALL
     unix% cd $ASCDS_INSTALL
     unix% tar xvf CIAO_4.1_scripts.tar


4) Re-index the ahelp database

   This step allows ahelp (the CIAO help system) to find the
   newly-installed script XML files automatically.  This step may take
   a few minutes to complete.

     unix% ahelp -r

   See "ahelp ahelp" for more information on this command.

   Users installing under Mac OSX who do not have root access enabled
   may need to use "sudo" to change the file permissions before
   reindexing: 

     unix% sudo chmod 666 $ASCDS_INSTALL/doc/xml/CXCHelp*

   To prevent corruption, make sure to change the file permissions
   back to "644" after the reindexing is complete.