INSTALLING girBLDRS You may need to be root, depending on the permissions of the directories where you choose to install the girBLDRS software. Hardware Requirements: Memory 512 Mb Disc 1 GB (for test data) 1. Unpacking Unpack the archive if you have not done so already, run the following two commands: gunzip girbldrs-${GIR_VER}.tar.gz # uncompress the archive tar xf girbldrs-${GIR_VER}.tar # unpack it This will create a girbldrs-${GIR_VER} directory containing the following files and directories: giraffe-4.0/ - The girBLDRS library itself pygiraffe-4.0/ - Python module to access giraffe library functions from Python pyfitsio-0.99/ - Python module to access FITS files using CFITSIO library pysmongo-1.0/ - Python interface module to SMONGO plotting library pyrecipes-3.1/ - girBLDRS data reduction recipes written in Python pyscripts-3.1/ - Miscellaneous usefull Python scripts arrayfrombuffer-2/ - Python module to support memory mapped Numeric arrays in Python Memdebug-1.5/ - Small debugging memory allocator REQUIRED/ - download directory for missing external packages README - readme file COPYING - GPL license INSTALL - This file QUICK_INSTALL - quick installation instructions INSTALL.configure - configure script generic help file INSTALL.REQUIRED - REQUIRED packages global help file buildall.sh - shell script to configure, build and install everything cleanall.sh - shell script to remove, config and build products in source directories biggles-1.6.3 - python plot library - this is not a part of the girbldrs; it is included in order to facilitate installation: this version has a girBLDRS compatible install procedure compared to the standard distribution. 2. Setting up environment You download/unpack into ${GIR_SRC} You install into ${GIR_ROOT} You must define some environment variables for the build process GIR_VER girBLDRS version for ex.: 1.13 GIR_SRC where you download the tar file of the package GIR_ROOT where you want to install girBLDRS GIR_PYTHON ${GIR_ROOT}/python PYTHONSTARTUP ${GIR_SRC}/girbldrs-${GIR_VER}/build_startup.py This is done like this: If your shell is bash, ksh, zsh or sh (dots to be replaced): GIR_ROOT=/............../girBLDRS export GIR_ROOT GIR_PYTHON=${GIR_ROOT}/python export GIR_PYTHON PYTHONSTARTUP=${GIR_SRC}/girbldrs-${GIR_VER}/build_startup.py export PYTHONSTARTUP In case your shell is csh or tcsh (dots to be replaced): setenv GIR_ROOT /............../girBLDRS setenv GIR_PYTHON ${GIR_ROOT}/python setenv PYTHONSTARTUP ${GIR_SRC}/girbldrs-${GIR_VER}/build_startup.py The installation will give an error message and will not proceed otherwise. The PYTHONSTARTUP value must be a full path starting with / 3. Prerequisites. girBLDRS requires Python at least version 2.0 but it should works with version > 1.6 if the distutils module is installed. see INSTALL.REQUIRED for details. Under Linux you should have both python2 and python2-devel RPM's installed to compile python modules. You can check your installed python modules with the command: 'rpm -qa | grep python' The python scripts and recipes make an intensive use of the Python Numeric module available at http://www.pfdubois.com/numpy/ and this one is also required. The configure scripts will also try to find if Python Numeric is already installed. Accesses to FITS file are done through the CFITSIO library available at http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html. The configure script will try to find it on your machine, if it is not there you will have to retrieve and install this library. if you run configure using the '--enable-download' option, the configure script will try to download into the REQUIRED/ directory the missing packages. You will have to install them and re-run configure. The file INSTALL.REQUIRED explains how to install those packages provided you already have Python on your system, if not, go to http://www.python.org to get informations about downloading and installing python. For each required external package there is an install script in the REQUIRED directory which perform the installation in the $GIR_ROOT path. All the graphics displayed by the girBLDRS are produces using a Python module called biggles, It also has to be present if you want to have graphics working. Biggles is available at http://biggles.sourceforge.net/. NOTES: It requires GNU plotutils installed! You will also need a decent ANSI-compliant C-compiler. 4. Configuring. In the source code top directory: GIR_SRC, cd ${GIR_SRC}/girbldrs-${GIR_VER} then, if your shell is bash, ksh, zsh or sh: ./configall.sh 2>&1 | tee configall.log or ./configall.sh > configall.log 2>&1 In case your shell is csh or tcsh: ./configall.sh |& tee configall.log or ./configall.sh >& configall.log should try to configure everything for your system and download missing external packages to the REQUIRED directory. You should install these package using the install_XXX.sh scripts. If you do not have biggles in your Python (use: python -c 'import biggles' to check) you must also run the 'install_Biggles.sh'. Typically you will have to do: cd REQUIRED ./install_Cfitsio.sh ./install_Plotutils.sh ./install_Biggles.sh 4. Building. This step compiles the giraffe library and builds the python modules. The girBLDRS uses the GNU autoconfigure script to guess correct values for various system-dependent variables used during compilation. If you don't know how to use GNU configure, read the file INSTALL.configure. In the source code top directory: GIR_SRC, cd ${GIR_SRC}/girbldrs-${GIR_VER} then, if your shell is bash, ksh, zsh or sh: ./buildall.sh 2>&1 | tee buildall.log or ./buildall.sh > buildall.log 2>&1 In case your shell is csh or tcsh: ./buildall.sh |& tee buildall.log or ./buildall.sh >& buildall.log The shell script buildall.sh try to do all the job if you don't need any specific settings, otherwise you will have to perform the following steps by hand. Using one of the previous command, depending of your shell, the output will go to the buildall.log file. WARNING By default the buildall.sh script runs all GNU configure scripts with the --enable-download option, which try to get missing external package from the network. If you do not want this behaviour run 'buildall.sh --disable-download' instead. This step must be done for each sub-directory of the girBLDRS, in the following order: arrayfrombuffer-2 pyfitsio-0.99 giraffe-4.0 pygiraffe-4.0 pyrecipes-3.1 pyscripts-3.1 cd sub-directory, then type: ./configure --config-cache --cache-file=../config.cache If you are compiling girBLDRS for your personal use and are restricted to your home directory, a simple method for building would be to choose some directory, say "$HOME/girBLDRS", and then type: ./configure --prefix=$HOME/girBLDRS --exec-prefix=$HOME/girBLDRS .... This will configure the girBLDRS software for your machine. Run ./configure -help to get a list of configuration options. Running `configure' takes awhile. While running, it prints some messages telling which features it is checking for. To compile the C and Python source code, type: make To install the package in $GIR_ROOT or any specified prefix: make install You can remove the program binaries and object files from the source code directory by typing `make clean'. To also remove the files that `configure' created (so you can compile the package for a different kind of computer), type `make distclean'. 5. Running. You will have to set some environment variables in the file .profile (or .login, depending on your shell) in your home directory to run the girBLDRS software. (Create the file if it is not there already.) This is done by one of the scripts girbldrs.csh or girbldrs.sh: add the following line to your .login (if your shell is csh, tcsh) source ${GIR_ROOT}/share/bin/girbldrs.csh or this one to your .profile (if your shell is bash, ksh, zsh or sh) . ${GIR_ROOT}/share/bin/girbldrs.sh You may need to change the values of GIR_CALIB depending on the directories where the calib data: frames and tables are stored After you have done this, you will need to login again, or re-source the profile or login before running the installed girBLDRS. You can also just source the ${GIR_ROOT}/share/bin/girbldrs.[c]sh script before using the girBLDRS software. 6. Documentation. The online HTML documentation is installed in .../doc/html/ The main page is .../doc/html/index.html The man pages are installed in .../doc/man/ 7. Testing. read file TESTING That's all. girBLDRS is now installed. ------------------------------------------------------------------------ Copyright (C) 2000-2002,2003 Gilles Simond Observatoire de Geneve, CH-1290 Geneve, Switzerland Last update: Wed Mar 26 14:46:41 MET 2003 (AB) __o0o__