Back to home page

sPhenix code displayed by LXR

 
 

    


Warning, /JETSCAPE/external_packages/README.md is written in an unsupported language. File is not indexed.

0001 ## MUSIC support
0002 
0003 MUSIC is a (3+1)D viscous hydrodynamical code developed at McGill university.
0004 (Official website: http://www.physics.mcgill.ca/MUSIC)
0005 MUSIC can be integrated into the JETSCAPE framework. To download the lastest
0006 version of MUSIC, one can run the shell script under the external_packages folder,
0007 
0008 ```bash
0009     ./get_music.sh
0010 ```
0011 
0012 This shell script will clone the latest version of MUSIC to external_packages folder.
0013 It also setup the enviroment variables for MUSIC to run. Specifically, MUSIC
0014 needs the folder path for the EOS tables. Please make sure the enviroment
0015 variable HYDROPROGRAMPATH to be set to the path for MUSIC code package.
0016 
0017 When compiling MUSIC with JETSCAPE, please turn on the MUSIC support option
0018 when generating the cmake configuration file,
0019 
0020 ```bash
0021     mkdir build
0022     cd build
0023     cmake -DUSE_MUSIC=ON ..
0024     make
0025 ```
0026 
0027 To run JETSCAPE with MUSIC, one needs to use MPI commands,
0028 
0029 ```bash
0030     mpirun -np 1 ./MUSICTest
0031 ```
0032 
0033 ## Running JETSCAPE with CLVisc
0034 In order to run clvisc in jetscape, one has to download it in external\_packages/, using 
0035 
0036 ```
0037 sh get_clvisc.sh
0038 ```
0039 
0040 Then compile and run the framework with a XML configuration file which turns clvisc on.
0041 ```
0042 cd build/
0043 cmake .. -DUSE_CLVISC=on
0044 make
0045 ./runJetscape ../config/jetscape_clvisc.xml
0046 ```
0047 If the cmake fails because OpenCL is not installed, please check it.
0048 OpenCL is delivered in MacOS by default. 
0049 If you use linux machine with Nvidia GPUs, you will need to install CUDA,
0050 which will provide OpenCL support.
0051 If you use linux machine with AMD GPUs, Intel GPUs or any CPUs,
0052 you will need to install AMD APP SDK.
0053 
0054 ## SMASH hadronic afterburner
0055 
0056 SMASH [https://smash-transport.github.io] is a hadronic transport approach
0057 developed at Frankfurt University and GSI by the group of
0058 Prof. H. Elfner (nee Petersen).  In JetScape SMASH can
0059 serve as an afterburner, useful to compute soft observables.
0060 
0061 ### Installing SMASH
0062 
0063 SMASH is published on github at https://github.com/smash-transport/smash.
0064 See SMASH Readme for libraries required by SMASH and how to install them.
0065 
0066 ```
0067   export EIGEN3_ROOT=<eigen install directory>/include/eigen3/
0068   export GSL_ROOT_DIR=$(gsl-config --prefix)
0069   export BOOST_ROOT=<boost install directory>
0070   export PYTHIA8DIR=${PYTHIAINSTALLDIR}/pythia8235
0071   export PYTHIA8_ROOT_DIR=${PYTHIAINSTALLDIR}/pythia8235
0072 
0073   export JETSCAPE_DIR=${HOME}/JETSCAPE-COMP
0074   export SMASH_DIR=${JETSCAPE_DIR}/external_packages/smash/smash_code
0075 
0076   cd ${JETSCAPE_DIR}/external_packages
0077   ./get_smash.sh
0078 ```
0079 
0080 ### Compiling JetScape with SMASH
0081 
0082 The usage of SMASH in JetScape as an afterburner requires hydro,
0083 sampler and SMASH itself. Therefore, to use it in JetScape,
0084 
0085 ```bash
0086     mkdir ${JETSCAPE_DIR}/build
0087     cd ${JETSCAPE_DIR}/build
0088     cmake -DUSE_MUSIC=ON -DUSE_ISS=ON -DUSE_FREESTREAM=ON -DUSE_SMASH=ON ..
0089 ```
0090 
0091 To run JetScape test with SMASH:
0092 
0093 ```bash
0094     cd build
0095     ./SMASHTest
0096 ```
0097 
0098 Currently the iSS sampler performs resonance decays after sampling.
0099 For reasonable physics with SMASH these decays should be switched off.
0100 
0101 ### Installing and Compiling JETSCAPE with IP-Glasma
0102 
0103 The use of IP-Glasma with the current version of JETSCAPE is not fully integrated.  A workaround is provided here and applies to using the **jetscape/base:stable** Docker image.
0104 
0105 ```
0106 cd ${JETSCAPE_DIR}/external_packages
0107 ./get_ipglasma.sh
0108 ```
0109 After the IP-Glasma package downloads, replace the file **${JETSCAPE_DIR}/external_packages/ipglasma/CMakeModules/FindFFTW.cmake** with this alternative FindFFTW.cmake found here:
0110 
0111 [Alternative FindFFTW.cmake File](https://git.jinr.ru/nica/bmnroot/-/blob/9fb98e26eb3e27fe379d3a61bad5d1567665bd81/cmake/modules/FindFFTW.cmake)
0112 
0113 Then create a file called fftw3.h in the **${JETSCAPE_DIR}/external_packages/ipglasma/src** folder that includes the contents of the file linked here:
0114 
0115 [fftw3.h File](https://github.com/FFTW/fftw3/blob/master/api/fftw3.h)
0116 
0117 Create a build folder and cd into it.
0118 ```
0119 cd ${JETSCAPE_DIR}
0120 mkdir build
0121 cd build
0122 ```
0123 
0124 Include the fftw library paths as part of your cmake command:
0125 
0126 ```
0127 cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_ROOT=ON -DUSE_MUSIC=ON -DUSE_ISS=ON -DUSE_FREESTREAM=ON -DUSE_SMASH=ON -DUSE_IPGlasma=ON -DFFTW_INCLUDE_DIR=/usr/lib/x86_64-linux-gnu/libfftw3.so.3.5.8 -DFFTW_LIBRARY=/usr/lib/x86_64-linux-gnu/libfftw3.so.3.5.8
0128 
0129 make -j4     # Builds using 4 cores; adapt as appropriate
0130 ```
0131 If you're not compiling all the external modules, you don't have to turn them on.