Software installation instructions (JLAB_VERSION 2.4)

These instructions are verified on:
These are instructions to install JLAB_VERSION 2.4. You can find supported JLAB_VERSION releases instructions below:

General Requirements:



Installation:

  1. (Optional): create a file in your home directory:
    .jlab_software
    that contains one line only, with the packages you're interested in. The default (also works if no such file is present):
    
    banks ccdb clhep evio geant4 gemc jana mlibrary mysql qt root scons xercesc
    			
    Click here for a version of .jlab_software that only has clhep, geant4, qt and xercesc.

    Only the packages inside .jlab_software will be considered when setting the environment.


  2. Choose a place to install the software. This place will be called JLAB_ROOT.

    A standard (but not necessary) choice for JLAB_ROOT is /opt/jlab_software:
    
    set JLAB_ROOT=/opt/jlab_software
    			
    Create the working directory:
    
    mkdir -p $JLAB_ROOT/2.4
    			
  3. Get the installation scripts:
    
    cd $JLAB_ROOT
    wget -c  http://www.jlab.org/12gev_phys/packages/sources/ceInstall/ceInstall_2.4.tar.gz
    tar -zxpf ceInstall_2.4.tar.gz --strip-components 1 -C 2.4
    			 
  4. Set the environment variables. You should put these lines in your login script:
    
    setenv JLAB_ROOT /opt/jlab_software
    source $JLAB_ROOT/2.4/ce/jlab.csh
    			
  5. Start a new shell. Now you should see a log similar to this
     > Common Environment Version:   (Wed Jan 22 2020)
     > Running as ungaro on enpungarombp.jlab.org
     > OS Release:    Darwin_macosx10.15-x86_64-clang11.0.0
     > JLAB_ROOT set to:     /opt/jlab_software
     > JLAB_SOFTWARE set to: /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0
    
     !! Attention:  BANKS  installation check /opt/projects/banks/bin  not found
     !! Attention:  CCDB  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/ccdb/ccdb-1.06.02/lib  not found
     !! Attention:  CLHEP  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/clhep/2.4.1.3/lib  not found
     !! Attention:  EVIO  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/evio/5.1/bin  not found
     !! Attention:  GEANT4  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/geant4/4.10.06/bin  not found
     !! Attention:  GEMC  installation check /opt/projects/gemc/source/gemc  not found
     !! Attention:  JANA  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/jana/0.8.0/bin/jana  not found
     !! Attention:  MLIBRARY  installation check /opt/projects/mlibrary/lib  not found
     !! Attention:  MYSQL  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/mysql/lib  not found
     !! Attention:  QT    installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/qt/system/clang_64/lib  not found
     !! Attention:  ROOT  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/root/6.18.04/bin/root-config  not found
     !! Attention:  SCONS  installation check /opt/jlab_software/devel/scons_bm/site_tools  not found
     !! Attention:  XERCESC  installation check /opt/jlab_software/devel/Darwin_macosx10.15-x86_64-clang11.0.0/xercesc/3.2.2/  not found
    			
  6. If you do, great! The enviroment seems correct and you're ready to run the installation scripts. Every script that you run below will replace the warning log with a successful one.
    Notice: if you already have some existing environment variables that you want to keep, use the option "keepmine":
    
    source $JLAB_ROOT/2.4/ce/jlab.csh keepmine
    		
  7. Choose the packages you wish to install by executing the corresponding script:
    
    cd $JLAB_ROOT/2.4/install
    				
    ./go_clhep
    ./go_xercesc
    ./go_qt
    (see notes below for non system-qt installation)
    ./go_geant4
    ./go_sconsscript
    ./go_evio
    ./go_mysql
    ./go_ccdb
    ./go_mlibrary
    ./go_gemc
    ./go_root
    ./go_banks
    ./go_jana
    			
    Note: All the packages listed above "go_gemc" are necessary to run gemc.

  8. Typical installation times:

    Package Approx Installation Time
    clhep 1-2 minutes
    xercesc 2 minute2
    qt (if system installed) 1 second
    qt (if installatin from scratch)• 20 minutes
    geant4† 10 minutes
    sconsscript 1 second
    evio 10 seconds
    mysql 1 second
    ccdb 20 seconds
    mlibrary‡ 2-3 minutes
    gemc 2 minutes
    root 25 minutes
    banks 5 seconds
    jana 1 minute

    Total (system qt) 40 minutes
    Total (qt from scratch) 1 hour

† (needs fast connection to download the cross section data)
‡ you will see a lot of warnings you can ignore related to assimp.
• The JLab environment is setup to use the system installation of Qt. If you want to install qt using their offline installer, set the environment variable QT_VERSION then use 'keepmine' on the jlab script:

setenv QT_VERSION 5.10.1
source $JLAB_ROOT/devel/ce/jlab.csh keepmine
	



Please email any comments/corrections/bug report/feature requests to Maurizio Ungaro.