delphes_EIC/docs/install.md

0001 ## Installation
0002
0003
0004 ### EJPM install
0005
0006 ejpm is EIC software centric package/build manager. It is the designed
0007 to be the default tool to build G4E on users machine, as it helps with:
0008
0009 - building dependent packages (with "right" compilation flags)
0010 - setup environment variables to run everything
0011 - help with what packages to install by system packet manager
0012 - rebuild/remove/clean existing packages
0013
0014 > Still, ejpm is not a requirement.
0015
0016 First, install ejpm itself:
0017
0018 ```bash
0019    pip install --user ejpm
0020 ```
0021
0022
0023
0024 (If you have certificate problems (JLab issue), don't have pip, or have other problems,
0025 [here is the detailed documentation](https://gitlab.com/eic/ejpm)
0026
0027 Install delphes and possible other dependencies packets (lhapdf, pythia8, fastjet)
0028
0029
0030 ```bash
0031
0032    # 1. System prerequesties (the most prerequesties are for CERN ROOT)
0033    ejpm req centos          # get list of required OS packets. Use `ubuntu` on debian
0034    sudo yum install ...     # install watever 'ejpm req' tells you
0035
0036    # 2. Where to install
0037    ejpm --top-dir=<where-to>   # Directory where packets will be installed
0038
0039    # 4. Install lhapdf, pythia9 and delphes
0040    ejpm install delphes
0041
0042    # 5.  Source environment
0043    source ~/.local/share/ejpm/env.sh  # Use *.csh file for tcsh
0044
0045 ```
0046
0047
0048
0049
0050 You have ROOT and Geant4 and don't want EJPM to build them?
0051 (Use your installations of ROOT and Geant4)
0052
0053 ```bash
0054
0055    # Before running 'ejpm install g4e'
0056    ejpm set root `$ROOTSYS`    # Path to ROOT installation
0057    ejpm set geant <path>       # Path to Geant4 installation
0058 ```
0059
0060 > (!) If you use your version of ROOT, all packages depending on ROOT should be
0061 > installed with the same C++ standard flags as root. So it it was C++11 or C++17, it should be used
0062 > everywhere. To set it in ejpm
0063 > ```ejpm config global cxx_standard=17```
0064 >
0065
0066 Hint (!). Run ejpm to overview all installed packets, environment and status by 'ejpm' command
0067
0068 Here is the sample output:
0069
0070 ```
0071
0072    > ejpm
0073
0074    EJPM v0.01.19
0075    top dir :
0076       /eic
0077    state db :
0078       ~/.local/share/ejpm/db.json  (users are encouraged to inspect/edit it)
0079    env files :
0080       ~/.local/share/ejpm/env.sh
0081       ~/.local/share/ejpm/env.csh
0082
0083    INSTALLED PACKETS: (*-active):
0084    vgm:
0085       * /eic/vgm/vgm-v4-5 (owned)
0086    root:
0087       * /eic/root/root-v6-16-00 (owned)
0088    geant:
0089          /eic/geant/geant-v10.5.0 (owned)
0090       * /eic/geant4-10.6-betta
0091    hepmc:
0092       * /eic/hepmc/hepmc-HEPMC_02_06_09 (owned)
0093    g4e:
0094       * /eic/g4e/g4e-dev (owned)
0095 ```
0096
0097
0098 ### Manual installation
0099
0100 Below, the environment variable ${INSTALLDIR} refers to some folder where you are putting all your EIC fast simulation code (e.g. export INSTALLDIR=${HOME}/EIC/).
0101
0102 1. Install PYTHIA8,
0103    * http://home.thep.lu.se/~torbjorn/Pythia.html,
0104    * Download the tarball and unpack it. ,
0105    * Configure it for local installation in your work area, make, install
0106    * If you intend to use PDFs besides the default PYTHIA PDF, you need to install LHAPDF6. The configuration instructions below assume you have done this already and want to build PYTHIA with support for LHAPDF
0107    ```
0108    ./configure --prefix=${INSTALLDIR}/EIC/ --with-lhapdf6=${INSTALLDIR}/EIC/
0109    make -j
0110    make install
0111    ```
0112    * Make sure the work area binary directory is in your PATH: ```PATH=${INSTALLDIR}/EIC/bin:${PATH}```,
0113
0114 1. Install Delphes,
0115    * https://github.com/delphes/delphes,
0116    * Clone the project and make sure you are on the master branch,
0117    * Make sure ROOT is available in your path, e.g. ```lsetup \"root 6.18.04-x86_64-centos7-gcc8-opt\"```,
0118    * Compile with PYTHIA8: ```HAS_PYTHIA8=true PYTHIA8=${INSTALLDIR}/EIC ./configure --prefix=${INSTALLDIR}/EIC/```,
0119    * Build, install
0120    ```
0121    make -j
0122    make install
0123    ```
0124
0125 1. Get the Delphes/EIC code for simulation and analysis of a detector baseline/configuration.,
0126    * https://github.com/eic/delphes_EIC,
0127    * Clone the repository locally,
0128    * Follow the instructions to run the example and generate a ROOT file.
0129
0130