PILMOS Package Distribution
===========================

Quick Summary
-------------
    This package is installed with two commands:
    ~$> ./unzip
    ~$> ./pilmos_install.sh .

    To run the PILMOS tool:
    ~$> pilmos.sh


Installing the Software
-----------------------
You have received three files distributed for observation period 90:
- README_P90: which you are reading now
- pilmosLINUXRH9_P90.tar.gz: the PILMOS package software for Period 90 
- unzip: a convenience macro to uncompress the above package into the current
         directory.

Please find a suitable directory in your computer where you have write
permissions and enough space (150 MB).

Supported Operating Systems are:
- Linux RedHat 9
- Scientific Linux with VLTSW
- Maybe others without support from ESO

Open a terminal and change to the chosen directory for installation of this
package.
If you don't find the unzip macro, type the following directly in the command
line and hit ENTER key:

~$> gzip -d -c pilmosLINUXRH9_P90.tar.gz | tar xvf - -C . > /dev/null [ENTER]

Now there are four new files in your installation directory:
- README_EXE
- README_INSTALL
- pilmosLINUXRH9.tar.gz
- pilmos_install.sh

To actually install the package, type the following in the command line:

~$> ./pilmos_install.sh . [ENTER]

Note the dot '.' at the end of the command, just before the ENTER key.
It tells the installer to use the current directory path for unpacking and
installing the software.

If you want to unpack the software in the current directory but install it
somewhere else, you must type the full absolute path (starting with '/') to the
new location instead of the '.', and then hit ENTER key.
If you don't type '.' or anything else, the script will prompt you for a path to
install; it offers the current directory's absolute path as default. If you hit
ENTER key then you are accepting this default path. You may change it by typing
another full absolute path and hitting ENTER key.

Under the chosen installation directory a pilmosLINUXRH9 directory is created.
Somewhere in the executable path of your system, symbolic links to the PILMOS
executable programs are created.


Running the PILMOS Tool
-----------------------
From the same terminal and directory you run the installation, you can execute
the installed software:

~$> pilmos.sh

Configuration data and output files can be found under $HOME/.pilmos/


Advanced
--------
Since this tool is designed as a plugin to the Skycat application, you can
modify its behaviour in the skycat configuration file you'll find in your home
directory at:

$HOME/.pilmos/skycat.cfg

There you'll also see a data_template.fits file, which is used by PILMOS as a
starting point to generate the simulated FITS files.

Should an error occur when executing the installed software, there is an option
to recompile the C program and libraries in your system. This usually fixes
segmentation violation errors and library access problems.

To install again with recompilation option, go back to the unpacking directory
(where pilmosLINUXRH9.tar.gz file was left) and execute the installer with -c
option:

~$> pilmos_install.sh -c . [ENTER]


Should you need to un-install this software and restore your executable paths to
their previous state, execute the installer with -u option:

~$> pilmos_install.sh -u . [ENTER]

Under the former installation directoy a file pilmosLINUXRH9.uninstall.done is
left. It contains the instructions executed to actually uninstall the
software,in case someone needs to check it.


A debugging option is also available which makes the installer print details
about the changes it is making in the system's paths. Execute the installer with
-d option in combination with either one of -c or -u:

~$> pilmos_install.sh -dc . [ENTER]


In all above cases do not forget to specify a full absolute path to the
installation directory which may be different from the current unpacking
directory (the dot '.').


___PILMOS___
