Skip to content

Commit

Permalink
Merge pull request #102 from JETSCAPE/XSCAPE-1.0-for-public-repo
Browse files Browse the repository at this point in the history
Xscape 1.0 for public repo
  • Loading branch information
latessa authored Apr 4, 2023
2 parents f650a0e + 8913cd1 commit 32212db
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/plot_observables.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test-build-external.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test-events-PbPb.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test-events-Pythia-Isr-Dat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test-events-Pythia-Isr-Hadron.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test-events-Pythia-Isr-Parton.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test-events-pp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 32212db

Please sign in to comment.