Skip to content

Commit 32d9630

Browse files
committed
update IP-Glasma install instructions in README
1 parent a2a243f commit 32d9630

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

.github/workflows/test-events-PbPb.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ jobs:
4646
uses: actions/checkout@v4
4747
with:
4848
repository: JETSCAPE/TEST-EXAMPLES
49-
ref: main
49+
ref: initialStageOrientation
5050
path: TEST-EXAMPLES
5151

5252
- name: Run Pb-Pb tests

external_packages/README.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -138,34 +138,35 @@ To run JetScape test with SMASH:
138138
Currently the iSS sampler performs resonance decays after sampling.
139139
For reasonable physics with SMASH these decays should be switched off.
140140

141-
### Installing and Compiling X-SCAPE with IP-Glasma
141+
## IP-Glasma
142142

143-
The use of IP-Glasma with the current version of X-SCAPE is not fully integrated. A workaround is provided here and applies to using the **jetscape/base:stable** Docker image.
143+
IP-Glasma requires the use of FFTW. The package `libfftw3-dev` is already included in JETSCAPE's supported [Docker image](https://hub.docker.com/r/jetscape/base).
144144

145-
```
146-
cd ${JETSCAPE_DIR}/external_packages
145+
### Installing IP-Glasma
146+
147+
To download IP-Glasma, one can run the shell script under the external_packages folder.
148+
149+
```bash
147150
./get_ipglasma.sh
148151
```
149-
After the IP-Glasma package downloads, replace the file **${JETSCAPE_DIR}/external_packages/ipglasma/CMakeModules/FindFFTW.cmake** with this alternative FindFFTW.cmake found here:
150152

151-
[Alternative FindFFTW.cmake File](https://git.jinr.ru/nica/bmnroot/-/blob/9fb98e26eb3e27fe379d3a61bad5d1567665bd81/cmake/modules/FindFFTW.cmake)
153+
This shell script will clone IP-Glasma to the external_packages folder.
152154

153-
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:
154-
155-
[fftw3.h File](https://github.com/FFTW/fftw3/blob/master/api/fftw3.h)
155+
### Compiling JETSCAPE with IP-Glasma
156156

157157
Create a build folder and cd into it.
158+
158159
```
159160
cd ${JETSCAPE_DIR}
160161
mkdir build
161162
cd build
162163
```
163164

164-
Include the fftw library paths as part of your cmake command:
165+
When compiling IP-Glasma with JETSCAPE, please turn on the IP-Glasma support option when generating the cmake configuration file.
165166

166-
```
167-
cmake .. -DCMAKE_CXX_STANDARD=17 -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
167+
```bash
168+
cmake .. -DUSE_3DGlauber=ON -DUSE_MUSIC=ON -DUSE_ISS=ON -DUSE_FREESTREAM=ON -DUSE_SMASH=ON -DUSE_IPGlasma=ON
168169

169-
make -j4 # Builds using 4 cores; adapt as appropriate
170+
make -j4 # Builds using 4 cores; adapt as appropriate
170171
```
171172
If you're not compiling all the external modules, you don't have to turn them on.

0 commit comments

Comments
 (0)