-------------------------------------------------------------------------------- GRESS - General Response Simulation System R.M. Kippen, LANL, Nov-2009 -------------------------------------------------------------------------------- Installation Guide GRESS Release 1.2.8 OVERVIEW: ========= This document provides a brief guide for installing the various software packages used by the GRESS code package. N.B. more detailed instructions for installing individual packages exist in most cases from their distributors. N.B. this guide is for installation only, not for use. Refer to the GRESS User's Guide for use information. N.B. for some of the required packages pre-built libraries for specific platforms may exist. It is strongly suggested NOT to use these, but rather to always compile from source using the directions given below. N.B. some of the packages take a long time to compile (e.g., several hours for GEANT4). PREREQUISITES: ============== * C++ compiler * F77 compiler * (the full set of packages has only been tested on Linux and MacOSX using the g++/gcc/g77 compiler suite) SUPPORTED PLATFORMS: ==================== The present version of GRESS is supported on Linux and Mac OS X operating systems. Several variants of these platform may suffice, but the package has only been tested with the following specific configurations. * Linux version 2.4.21-27.ELsmp (Redhat Enterprise Linux) - gcc version 3.2.3 20030502 (Red Hat Linux 3.2.3-53) * Linux version 2.6.9-cm46 (Redhat Enterprise Linux) - gcc version 3.4.2 20041017 (Red Hat 3.4.2-6.fc3) * Linux version 2.4.24-cm32lnxi6plsd4pcsmp (root@cm-7.lanl.gov) - gcc version 3.2.2 20030222 (Red Hat Linux 3.2.2-5) * Mac OS X, 10.5.8 - gcc version 4.0.1 (Apple Inc. build 5490) - X11 v1.1.3 (Xfree86 4.4.0) - Xcode v2.4 (including X11 Development Kit) QUICKLIST OF REQUIRED PACKAGES: =============================== For all platforms: CLHEP - http://proj-clhep.web.cern.ch/proj-clhep/ GEANT4 - http://geant4.cern.ch/ ROOT - http://root.cern.ch/ XERCESC - http://xml.apache.org/xerces-c/ CFITSIO - http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html CCFITS - http://heasarc.gsfc.nasa.gov/docs/software/fitsio/ccfits/ GRESS - This package. Specific to Mac OS X: X11 User - http://www.apple.com/macosx/features/x11/ Xcode - http://www.apple.com/macosx/features/xcode/ (be sure to install optional X11 Software Development Kit) GRESS/GEANT4 COMPATIBILITY TABLE: ================================= As noted in the next section, GRESS can only be assured to work with the versions of underlying libraries that it was tested with. Furthermore, in the case of GEANT4, we demand that specific releases of GRESS be used with specific releases of GEANT4. This is to prevent the difficult situation of generating conflicting results with the same version of GRESS. As of GRESS 1.09 this compatibility is no longer enforced at the patch level since CERN does not archive all GEANT4 patches. Below is the forced compatibility table. As of GRESS 1.1.0, we also demand that specific releases of GRESS be used with specific releases of the GEANT4 LowEnergy EM Physics Data Files (G4EMLOW) for similar reasons as listed above. GRESS GEANT4 ----- ------ 1.28 4.9.1 or 4.9.2 (any patch level), G4EMLOW5.x or G4EMLOW6.x 1.20 4.9.1 (any patch level), G4EMLOW5.1 1.10 4.9.1 (any patch level), G4EMLOW5.1 1.09 4.8.0 (any patch level), any G4EMLOW 1.08 4.7.1, any G4EMLOW 1.07 4.7.0.p01 (p01 == patch 01), any G4EMLOW 1.02 4.6.2.p02 (p02 == patch 02), any G4EMLOW PACKAGES AND INSTALLATION: ========================== Installation guide below is verfied to work on the supported platforms in their specific test configurations. N.B. The order of installation is important due to package dependencies. .____________. | 1. CLHEP | ~~~~~~~~~~~~~~ Description: Collection software libraries releated to High Energy Physics used extensively by the GEANT4 package. Versions: As required by version of GEANT4 Tested version: 2.0.3.3 Location: http://proj-clhep.web.cern.ch/proj-clhep/ Installation: 1- Download and unpack source tarball files in a suitable directory (this creates a directory called /CLHEP) 2- cd ./CLHEP 3- ./configure 4- make install prefix= (e.g., /usr/local/CLHEP ; don't use prefix=.) 5- Move or rename CLHEP directory to desired location Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. ._____________. | 2. GEANT4 | ~~~~~~~~~~~~~~~ Description: Large set of libraries from CERN containing and integrated tooset for performing Monte Carlo radiation transport simulations. Versions: GEANT4.9.1 or GEANT4.9.2 is required for this version of GRESS Tested version: 4.9.1.p02 G4EMLOW5.X LowEnergy EM Physics data files required for this version of GRESS Location: http://geant4.cern.ch/ Installation: 1- Download and unpack source tarball files in a suitable directory (this creates a directory called geant4.x.x -- do not rename!) 2- Download and unpack the "low-energy data files" tarball (this creates a directory called G4EMLOWX.X) 3- Use the G4BUILDENV_.sh script file (included in the GRESS/doc directory) to create the appropriate environment variables a. Edit the following variables appropriately GEANT_DIR, G4SYSTEM, G4INSTALL, CLHEP_BASE_DIR, G4LEDATA b. Type "source G4BUILDENV_.sh" (add this in your .cshrc file to execute for every new shell or login) 4- cd $G4INSTALL/source 5- make global >> g4install.log (this takes hours to compile all libraries!) 6- make includes Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. .__________. | 3. ROOT | ~~~~~~~~~~~~ Description: Package of (mainly C++) software libraries/programs for high-energy physics research from CERN. Versions: Typically requires the latest stable version. Tested version: 5.17/06 Location: http://root.cern.ch Installation: 0- N.B. If upgrading from a previous version make sure ROOTSYS variable is properly unset before building new version. 1- Download source code tarball 2- Unpack tarball (creates ./root directory) 3- cd ./root 4- ./configure linux --enable-opengl (For MAC OSX use: ./configure macosx --enable-opengl) 5- make 6- make install Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. ._____________. | 4. XERCESC | ~~~~~~~~~~~~~~~ Description: Set of libraries from Apache.org that provide tools for handling XML files. Versions: Latest version is not always compatible with GRESS. Tested version: 2.8.0 Location: http://xml.apache.org/xerces-c/ Installation: 1- Download and unpack source tarball files in a suitable directory (creates a directory called xerces-c-src_X_X_X) 2- setenv XERCESCROOT /xerces-c-src_X_X_X 3- cd $XERCESCROOT/src/xercesc 4- autoconf 5- ./runConfigure -plinux -cgcc -xg++ -minmem -nsocket -tnative -rpthread (For MAC OSX use: ./runConfigure -p macosx -n native) 6- make Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. ._____________. | 5. CFITSIO | ~~~~~~~~~~~~~~~ Description: Set of C libraries from NASA/GSFC that provide tools for handling FITS files. Versions: Tested version: 3.090 Location: http://heasarc.gsfc.nasa.gov/docs/software/fitsio/fitsio.html Installation: 1- Download Unix/VMS .tar.gz file 2- Unpack tarball (creates ./cfitsio directory) 3- cd cfitsio 4- ./configure --prefix=/cfitsio 5- make (builds static library) 6- make shared (builds shared library) 7- make install (moves libraries/includes into appropriate areas) 8- make clean (removes uneeded object files) Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. ._____________. | 6. CCFITS | ~~~~~~~~~~~~~~~ Description: Set of C++ libraries from NASA/GSFC that provide tools for handling FITS files. Versions: Latest version is not always compatible with GRESS. Tested version: 2.0 Location: http://heasarc.gsfc.nasa.gov/docs/software/fitsio/ccfits/ Installation: 1- Download and unpack source tarball file in a suitable directory (creates a directory called CCfits -- DO NOT RENAME) 2- cd ./CCfits 3- ./configure --enable-static --enable-shared \ --prefix=/CCfits-X.X \ --with-cfitsio=/cfitsio 4- make install 5- make clean (removes uneeded object files) 6- Rename CCFits directory (e.g., CCFits-2.0) if desired Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. ._____________. | 7. GRESS | ~~~~~~~~~~~~~~~ Description: General REsponse Simulation System Versions: Latest. Tested version: 1.2.8 Location: TBD Installation: 0- Ensure that all packages described above are properly installed and that all startup environment variables are properly set (see below). 1- Obtain and unpack source tarball file in a suitable directory (creates a directory called GRESS-X_X_X) 2- cd ./GRESS-X_X_X 3- make (this builds all GRESS codes. Individual codes can built separately by performing make from their individual subdirectories.) 4- cp ./g4lecs/data/comp/* $G4LEDATA/comp (This assumes that the G4LEDATA variable points at the G4LowEnergy data file directory as directed in the GEANT4 installation above) 5- cd ./test make [option to run test scripts for all GRESS programs] 6- Add the following environment variable to your startup shell script ( for complete list of startup environment see below) Ensure that the environment variables are properly set as described in the "STARTUP ENVIRONMENT" section below. STARTUP ENVIRONMENT: ==================== After installation, there are several environment variables required to use the packages. Two shell scripts are included in the $GRESS_DIR/docs directory to simplify the process. GRESSENV_. - sets up variables for all packages GEANT4ENV_. - sets up GEANT4 variables (called by above) where the .csh versions are for c-shell (and variants like tcsh) and the .ksh versions are for k-shell (and variants like bash). Typical use of these scripts requires the following. Users with more demanding needs may simply copy the information from these scripts into their own scripts. 0- Copy the scripts appropriate for your platform and shell version to a desired location. 1- Edit the scripts so they match your specific needs. In particular, specifiy the pathnames inthe first lines. 2- Type "source SWBUILDENV_." which should execute both scripts so that you are ready to run GRESS. Most users will want to execute these scripts for every new shell by adding this command to their login startup script file such as $HOME/.cshrc or $HOME/.bashrc DOCUMENT HISTORY: ================= 1.28/NOV-2009....New GRESS release. 1.11/MAR-2008....New GRESS release, no changes to this document. 1.10/JAN-2008....Updates and corrections for new GRESS release. 1.09/FEB-2006....Updates and corrections for new GRESS release. 1.08/JUL-2005....Updates and corrections for new GRESS release. 1.07/MAY-2005....Updates and corrections for new GRESS release. 1.00/NOV-2004....First version. 2.00/MAY-2005 PROBLEMS/QUESTIONS: =================== Marc Kippen, mkippen@lanl.gov, 505-667-3125 Andrew Hoover, ahoover@lanl.gov, 505-664-0979 -------------------------------------------------------------------------------- -eof-