Skip to content

Commit

Permalink
changed README to point to X-SCAPE wiki instead of JETSCAPE
Browse files Browse the repository at this point in the history
  • Loading branch information
latessa committed Mar 13, 2023
1 parent 4bb388c commit 8913cd1
Showing 1 changed file with 2 additions and 13 deletions.
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 8913cd1

Please sign in to comment.