Merge pull request #2 from JETSCAPE/XSCAPE-1.0-for-public-repo

Xscape 1.0 for public repo

Author: latessa

.github/workflows/plot_observables.yaml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   PULL_NUMBER: ${{ github.event.number }}

.github/workflows/test-build-external.yaml

@@ -4,10 +4,14 @@ on:
   pull_request:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   REPO_NAME: ${{ github.event.repository.name }}

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

@@ -4,10 +4,14 @@ on:
   pull_request:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   REPO_NAME: ${{ github.event.repository.name }}

.github/workflows/test-events-Pythia-Isr-Dat.yaml

@@ -4,10 +4,14 @@ on:
   pull_request:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   REPO_NAME: ${{ github.event.repository.name }}
@@ -28,17 +32,19 @@ jobs:
       with:
         path: ${{ github.event.repository.name }}
 
-    - name: Download 3DGlouber
+    - name: Download 3DGlauber
       run: |
         cd ${GITHUB_WORKSPACE}/${REPO_NAME}/external_packages
         ./get_3dglauber.sh
+        ./get_music.sh
+        ./get_iSS.sh
 
     - name: Build Application
       run: |
         cd ${GITHUB_WORKSPACE}/${REPO_NAME}
         mkdir build
         cd build
-        cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON
+        cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON -DUSE_MUSIC=ON -DUSE_ISS=ON
         make -j2
 
     - name: Checkout TEST-EXAMPLES

.github/workflows/test-events-Pythia-Isr-Hadron.yaml

@@ -4,10 +4,14 @@ on:
   pull_request:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   REPO_NAME: ${{ github.event.repository.name }}
@@ -28,17 +32,19 @@ jobs:
       with:
         path: ${{ github.event.repository.name }}
 
-    - name: Download 3DGlouber
+    - name: Download 3DGlauber
       run: |
         cd ${GITHUB_WORKSPACE}/${REPO_NAME}/external_packages
         ./get_3dglauber.sh
+        ./get_music.sh
+        ./get_iSS.sh
 
     - name: Build Application
       run: |
         cd ${GITHUB_WORKSPACE}/${REPO_NAME}
         mkdir build
         cd build
-        cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON
+        cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON -DUSE_MUSIC=ON -DUSE_ISS=ON
         make -j2
 
     - name: Checkout TEST-EXAMPLES

.github/workflows/test-events-Pythia-Isr-Parton.yaml

@@ -4,10 +4,14 @@ on:
   pull_request:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   REPO_NAME: ${{ github.event.repository.name }}
@@ -28,17 +32,19 @@ jobs:
       with:
         path: ${{ github.event.repository.name }}
 
-    - name: Download 3DGlouber
+    - name: Download 3DGlauber
       run: |
         cd ${GITHUB_WORKSPACE}/${REPO_NAME}/external_packages
         ./get_3dglauber.sh
+        ./get_music.sh
+        ./get_iSS.sh
 
     - name: Build Application
       run: |
         cd ${GITHUB_WORKSPACE}/${REPO_NAME}
         mkdir build
         cd build
-        cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON
+        cmake .. -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON -DUSE_MUSIC=ON -DUSE_ISS=ON
         make -j2
 
     - name: Checkout TEST-EXAMPLES

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

@@ -4,10 +4,14 @@ on:
   pull_request:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
   push:
     branches:
       - main
+      - XSCAPE-RC2
+      - XSCAPE-1.0-for-public-repo
 
 env:
   REPO_NAME: ${{ github.event.repository.name }}

.gitignore

@@ -9,6 +9,7 @@
 *.*~
 .DS_Store
 .vscode
+.bash_history
 html/*
 build*/*
 external_packages/LBT*

CMakeLists.txt

@@ -104,10 +104,10 @@ endif (USE_SMASH)
 message("Compiler and Linker flags ...")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC -pipe -Wall -std=c++11")
 ## can turn off some warnings
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-reorder -Wno-unused-variable -Wno-deprecated-copy -Wno-unused-value")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-reorder -Wno-unused-variable -Wno-inconsistent-missing-override -Wno-unused-private-field")
 ## Then set the build type specific options. These will be automatically appended.
 set(CMAKE_CXX_FLAGS_DEBUG "-g -O0")
-set(CMAKE_CXX_FLAGS_RELEASE "-O3 -w")
+set(CMAKE_CXX_FLAGS_RELEASE "-O3")
 
 ## can turn on debugging information
 # set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
@@ -117,7 +117,7 @@ set(CMAKE_CXX_FLAGS_RELEASE "-O3 -w")
 if (APPLE)
     message( STATUS "Apple : " ${CMAKE_HOST_SYSTEM})
     if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "AppleClang")
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++ -Wno-inconsistent-missing-override -Wno-unused-private-field -Wno-delete-non-abstract-non-virtual-dtor")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++" )
     elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-sign-compare -Wno-unused-but-set-variable -Wno-parentheses -fext-numeric-literals")
     endif()
@@ -310,6 +310,7 @@ if (USE_ROOT)
   if (${ROOT_FOUND})
     #include_directories(${ROOT_INCLUDES})
     include_directories(${ROOT_INCLUDE_DIRS})
+    set( CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} -DUSE_ROOT" )
     Message(STATUS "ROOT Include dir : " ${ROOT_INCLUDE_DIRS})
     Message(STATUS "ROOT Libraries : " ${ROOT_LIBRARIES})
   endif()
@@ -348,6 +349,12 @@ include_directories(./external_packages/gtl/include )
 include_directories(./external_packages/hydro_from_external_file )
 include_directories(./examples/ )
 
+if (USE_ROOT)
+  if ("${ROOT_FOUND}")
+    include_directories(./src/root)
+    #add_subdirectory(./src/root)
+  endif()
+endif(USE_ROOT)
 
 ### include_directories will be expanded as packages are found
 
@@ -432,13 +439,6 @@ if (OPENCL_FOUND AND USE_CLVISC)
   add_subdirectory( ${CMAKE_SOURCE_DIR}/external_packages/clvisc_wrapper )
 endif (OPENCL_FOUND AND USE_CLVISC)
 
-if (USE_ROOT)
-  if (${ROOT_FOUND})
-          include_directories(./src/root)
-          add_subdirectory(./src/root)
-  endif()
-endif(USE_ROOT)
-
 ###########################
 ### Binary location     ###
 ###########################
@@ -477,20 +477,25 @@ target_link_libraries(FinalStateHadrons JetScape )
 add_executable(FinalStatePartons ./examples/FinalStatePartons.cc)
 target_link_libraries(FinalStatePartons JetScape )
 
-if(USE_3DGlauber)
+add_executable(PythiaBrickTest ./examples/custom_examples/PythiaBrickTest.cc)
+target_link_libraries(PythiaBrickTest JetScape )
+
+if(USE_3DGlauber AND USE_MUSIC AND USE_ISS)
   add_executable(PythiaIsrTest ./examples/PythiaIsrTest.cc)
   target_link_libraries(PythiaIsrTest JetScape )
-endif (USE_3DGlauber )
-
-#add_executable(PythiaBrickTest ./examples/custom_examples/PythiaBrickTest.cc)
-#target_link_libraries(PythiaBrickTest JetScape )
+  add_executable(PythiaIsrMUSIC ./examples/custom_examples/PythiaIsrMUSIC.cc)
+  target_link_libraries(PythiaIsrMUSIC JetScape )
+endif (USE_3DGlauber AND USE_MUSIC AND USE_ISS )
 
 #add_executable(PythiaBDMTest ./examples/custom_examples/PythiaBDMTest.cc)
 #target_link_libraries(PythiaBDMTest JetScape )
 
 #add_executable(PythiaNoBDMTest ./examples/custom_examples/PythiaNoBDMTest.cc)
 #target_link_libraries(PythiaNoBDMTest JetScape )
 
+#add_executable(PythiaBDMTest_Hydro_Cascade ./examples/custom_examples/PythiaBDMTest_Hydro_Cascade.cc)
+#target_link_libraries(PythiaBDMTest_Hydro_Cascade JetScape )
+
 if ( USE_SMASH )
     add_executable(SMASHTest ./examples/custom_examples/SMASHTest.cc)
     target_link_libraries(SMASHTest JetScape )
@@ -515,10 +520,10 @@ if ( USE_MUSIC AND USE_ISS AND USE_SMASH )
 endif ( USE_MUSIC AND USE_ISS AND USE_SMASH )
 
 if (USE_ROOT)
-  if (${ROOT_FOUND})
-    add_executable(PythiaBrickTestRoot ./examples/custom_examples/PythiaBrickTestRoot.cc)
-    target_link_libraries(PythiaBrickTestRoot JetScape JetScapeRoot)
-  endif(${ROOT_FOUND})
+  #if (${ROOT_FOUND})
+  #  add_executable(PythiaBrickTestRoot ./examples/custom_examples/PythiaBrickTestRoot.cc)
+  #  target_link_libraries(PythiaBrickTestRoot JetScape)
+  #endif(${ROOT_FOUND})
 endif(USE_ROOT)
 
 

README.md

@@ -1,4 +1,4 @@
-# X-SCAPE 0.9.1
+# X-SCAPE 1.0
 
 The X-ion collisions with a Statistically and Computationally Advanced Program Envelope (X-SCAPE) is the enhanced (and 2nd) project of the JETSCAPE
 collaboration which extends the framework to include small systems created in p-A and p-p collisions, lower energy heavy-ion collisions and electron-Ion collisions.
@@ -16,18 +16,7 @@ Please cite [The JETSCAPE framework](https://arxiv.org/abs/1903.07706) if you us
 
 ## Installation
 
-When following the JETSCAPE installation instructions to install X-SCAPE, the Docker image tagged **v1.8** should be used instead of the image tagged as **stable**.
-
-For example, when the JETSCAPE instructions specify creating a container using the **stable** tag:
-```
-docker run -it -v ~/jetscape-docker:/home/jetscape-user --name myJetscape --user $(id -u):$(id -g) jetscape/base:stable
- ```
- Instead use **v1.8** when installing X-SCAPE:
- ```
- docker run -it -v ~/jetscape-docker:/home/jetscape-user --name myJetscape --user $(id -u):$(id -g) jetscape/base:v1.8
- ```
-
-Also, dependencies in Docker image **v1.8** require cmake to be called specifying the language standard C++14 or greater when compiling X-SCAPE.
+Note that X-SCAPE dependencies require cmake to be called specifying the language standard C++14 or greater.
 
 For example, to compile X-SCAPE for the ISR run with [3DGlauber support](#3dglauber-support), run the get_3dglauber.sh script from the external_packages folder:
 ```bash
@@ -42,7 +31,7 @@ make -j4   # Builds using 4 cores; adapt as appropriate
 ```
 If installing X-SCAPE with SMASH, the [get_smash.sh](https://github.com/JETSCAPE/X-SCAPE-COMP/blob/main/external_packages/get_smash.sh) script will clone an [alternate branch](https://github.com/smash-transport/smash/tree/staudenmaier/mod_plist_ts) of SMASH currently required for use with X-SCAPE.  A future release of SMASH will bring X-SCAPE support to SMASH's main branch.
 
-Please see the [Installation Instructions](https://github.com/JETSCAPE/JETSCAPE/wiki/Doc.Installation).
+Please see the complete [Installation Instructions](https://github.com/JETSCAPE/X-SCAPE/wiki/Doc.Installation) here.
 
 ## Running X-SCAPE/JETSCAPE
 
@@ -130,11 +119,14 @@ To compile the 3DGlauber code together with the JETSCAPE framework, please turn
     cmake -DCMAKE_CXX_STANDARD=14 -DUSE_3DGlauber=ON ..
     make -j4
 ```
+
+For more details see [3DGlauber](https://github.com/JETSCAPE/X-SCAPE/wiki/3DGlauber,-MUSIC,-iSS-and-Initial-State-Radiation).
+
 ### Initial State Shower using iMatter
 
 To use the ISR shower of iMatter, please make sure that the environment variable `$PYTHIA8` is set and points to the directory where pythia8 is installed which can be found using `pythia8-config --prefix`. If you use the JETSCAPE docker container (v1.8), all environment variables, including the `$PYTHIA8` for iMatter are set properly.
 
-After using 3DGlauber support to compile JETSCAPE, one can use `./PythiaIsrTest` (in the build directory) to run iMatter and 3DGlauber which uses the xml user file `config/jetscape_user_iMATTERMCGlauber.xml`
+After using 3DGlauber support to compile JETSCAPE, one can use `./PythiaIsrTest` (in the build directory) to run iMatter and 3DGlauber which uses the xml user file `config/jetscape_user_iMATTERMCGlauber.xml`. For running 3DGlauber with Hydro (Music) please see [3DGlauber](https://github.com/JETSCAPE/X-SCAPE/wiki/3DGlauber,-MUSIC,-iSS-and-Initial-State-Radiation).
 
 
 ## JETSCAPE modules