diff --git a/.github/workflows/plot_observables.yaml b/.github/workflows/plot_observables.yaml index fd611bfa..aab260b8 100644 --- a/.github/workflows/plot_observables.yaml +++ b/.github/workflows/plot_observables.yaml @@ -5,7 +5,7 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: PULL_NUMBER: ${{ github.event.number }} diff --git a/.github/workflows/test-build-external.yaml b/.github/workflows/test-build-external.yaml index 9411af06..663b3c9b 100644 --- a/.github/workflows/test-build-external.yaml +++ b/.github/workflows/test-build-external.yaml @@ -5,14 +5,13 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo - - XSCAPE-RC2 + - XSCAPE-1.0-for-public-repo push: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: REPO_NAME: ${{ github.event.repository.name }} diff --git a/.github/workflows/test-events-PbPb.yaml b/.github/workflows/test-events-PbPb.yaml index e6b00e03..942e9a5b 100644 --- a/.github/workflows/test-events-PbPb.yaml +++ b/.github/workflows/test-events-PbPb.yaml @@ -5,14 +5,13 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo - - XSCAPE-RC2 + - XSCAPE-1.0-for-public-repo push: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: REPO_NAME: ${{ github.event.repository.name }} diff --git a/.github/workflows/test-events-Pythia-Isr-Dat.yaml b/.github/workflows/test-events-Pythia-Isr-Dat.yaml index 15358bbe..e2ecd4a5 100644 --- a/.github/workflows/test-events-Pythia-Isr-Dat.yaml +++ b/.github/workflows/test-events-Pythia-Isr-Dat.yaml @@ -5,14 +5,13 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo - - XSCAPE-RC2 + - XSCAPE-1.0-for-public-repo push: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: REPO_NAME: ${{ github.event.repository.name }} diff --git a/.github/workflows/test-events-Pythia-Isr-Hadron.yaml b/.github/workflows/test-events-Pythia-Isr-Hadron.yaml index 56d47442..07f7696f 100644 --- a/.github/workflows/test-events-Pythia-Isr-Hadron.yaml +++ b/.github/workflows/test-events-Pythia-Isr-Hadron.yaml @@ -5,14 +5,13 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo - - XSCAPE-RC2 + - XSCAPE-1.0-for-public-repo push: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: REPO_NAME: ${{ github.event.repository.name }} diff --git a/.github/workflows/test-events-Pythia-Isr-Parton.yaml b/.github/workflows/test-events-Pythia-Isr-Parton.yaml index 95551081..7888f559 100644 --- a/.github/workflows/test-events-Pythia-Isr-Parton.yaml +++ b/.github/workflows/test-events-Pythia-Isr-Parton.yaml @@ -5,14 +5,13 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo - - XSCAPE-RC2 + - XSCAPE-1.0-for-public-repo push: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: REPO_NAME: ${{ github.event.repository.name }} diff --git a/.github/workflows/test-events-pp.yaml b/.github/workflows/test-events-pp.yaml index 829d3f9c..1903ef5f 100644 --- a/.github/workflows/test-events-pp.yaml +++ b/.github/workflows/test-events-pp.yaml @@ -5,14 +5,13 @@ on: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo - - XSCAPE-RC2 + - XSCAPE-1.0-for-public-repo push: branches: - main - XSCAPE-RC2 - - XSCAPE-0.9.1-for-public-repo + - XSCAPE-1.0-for-public-repo env: REPO_NAME: ${{ github.event.repository.name }} diff --git a/README.md b/README.md index 5a9ab725..7d29694b 100644 --- a/README.md +++ b/README.md @@ -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