Default-tunes

Tested default tunes for JETSCAPE and X-SCAPE

Currently, the following tunes are available in the publications_config directory:

• PP arXiv:1910.05481

• AA (soft) arXiv:2011.01430

• AA (hard) arXiv:2204.01163

The different tunes can be run by:

./runJetscape <path to>/publications_config/arXiv_<number>/jetscape_user_system_arXiv.xml

Instructions for adding XML files

When a new JETSCAPE paper is published, please add the XML file(s) to publications_config/arXiv_# and name the corresponding XML files similar to this one from the PP tune: jetscape_user_PP_1910.05481.xml. Specify the system (PP, AA, PA, ...) and put the arXiv number in the name.

If there is more information needed to reproduce the results an additional README.md file can be placed in the directory for the publication. Mention the version of JETSCAPE or X-SCAPE used for the tune.

When XML files are added to the repository, an entry should be added in this file.

Running tunes in Docker with specific versions of JETSCAPE or X-SCAPE

The JETSCAPE Collaboration maintains Docker images with fully installed versions of JETSCAPE and X-SCAPE for the past several releases. The images are available here for JETSCAPE and here for X-SCAPE.

Use the DockerHub repository and tag corresponding to the version you want to run. For example, to run the PP tune with JETSCAPE 3.7.1, follow these steps:

1. From a Linux bash shell, navigate to the repository's publications_config directory:

cd publications_config

2. Run the runContainer.sh script to execute the simulation. Pass the path to the XML tune and the image <repository>:<tag> for the version of JETSCAPE or X-SCAPE you want to run. The image will be downloaded if it isn't available locally.

./runContainer.sh arXiv_1910.05481/jetscape_user_PP_1910.05481.xml jetscape_full:v3.7.1

• Note that it is required to have either Docker or Apptainer/Singularity installed on your system but it is not required to have JETSCAPE or X-SCAPE installed, as these images contain the full installation.

• Output .dat files will be written to the host system current working directory.

• The simulation will write a temporary directory to the host system current working directory, which will be removed after the simulation completes.

Running tunes in Apptainer with specific versions of JETSCAPE or X-SCAPE

Apptainer (formerly Singularity) is especially useful on HPC clusters where Docker is likely unavailable. If Docker is unavailable, the runContainer.sh script will then check for and use Apptainer.

Request an interactive job on the cluster and ensure necessary modules are loaded (for example, module load apptainer) before running the runContainer.sh script.