Merge pull request #28 from JETSCAPE/roch/sort_xml_files

New XML file structure for tunes

Author: latessa

README.md

@@ -75,16 +75,14 @@ An example reading an ascii output file is provided:
 ./build/readerTest
 ```
 
-which reads in the generated showers does some DFS search and shows the output. You can generate an output graph format which can be easily visualized using graphViz or other tools like Gephi (GUI for free for Mac) or more advanced, graph-tools (Python) and many more. Furthermore, as a "closure" test, the FastJet core package (compiled in our JetScape library) is used to perform a simple jetfinding (on the "final" partons, in graph language, incoming partons in a vertex with no outgoing partons/childs), and since the "shower" is perfectly collinear the jet pT is identical to the hard process parton pT (modulo some random new partons/roots in the final state, see above).  
+which reads in the generated showers does some DFS search and shows the output. You can generate an output graph format which can be easily visualized using graphViz or other tools like Gephi (GUI for free for Mac) or more advanced, graph-tools (Python) and many more. Furthermore, as a "closure" test, the FastJet core package (compiled in our JetScape library) is used to perform a simple jetfinding (on the "final" partons, in graph language, incoming partons in a vertex with no outgoing partons/childs), and since the "shower" is perfectly collinear the jet pT is identical to the hard process parton pT (modulo some random new partons/roots in the final state, see above).
 
 ## JETSCAPE Tunes
 
-Currently, there exists a pp tune [PP19](https://arxiv.org/abs/1910.05481), which can be run by:
-```bash
-./runJetscape ../config/jetscape_user_PP19.xml
-```
+There are several JETSCAPE tunes from publications available.
+The XML files to reproduce the results are available in the `config/publications_config` directory.
+Please see [JETSCAPE Tunes](config/publications_config/README.md) for more information.
 
-Tuning of Pb-Pb is ongoing.
 Several example hydro profiles can be downloaded using `examples/get_hydroSample*`.
 
 ## X-SCAPE modules (New)
@@ -243,7 +241,6 @@ More material on the physics behind JETSCAPE and how to use it can be found in t
 ## Troubleshooting
 
 If you encounter a problem, please report the issue [here](https://github.com/JETSCAPE/JETSCAPE/issues).
-Please be sure to include enough information so that we can reproduce your issue: your platform, JETSCAPE version, configuration file, and anything else that may be relevant.
 
 # Contributing
 

config/publications_config/README.md

@@ -0,0 +1,24 @@
+# JETSCAPE Tunes
+
+Currently, the following tunes are available:
+
+- PP [arXiv:1910.05481](https://arxiv.org/abs/1910.05481)
+
+- AA (soft) [arXiv:2011.01430](https://arxiv.org/pdf/2011.01430)
+
+- AA (hard) [arXiv:2204.01163](https://arxiv.org/pdf/2204.01163)
+
+The different tunes can be run by:
+```
+./runJetscape ../config/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.
+
+When XML files are added to the repository, an entry should be added in this file.

config/jetscape_user_PP19.xml config/publications_config/arXiv_1910.05481/jetscape_user_PP_1910.05481.xml

@@ -0,0 +1,8 @@
+# arXiv:2011.01430
+
+The `jetscape_user_AA_2011.01430.xml` file contains one specific parameter set
+from the runs in [arXiv:2011.01430](https://arxiv.org/pdf/2011.01430).
+See table II in there, which summarizes the MAP parameters for the different runs.
+
+The `cross-section` parameter for Trento has to be 4.2 for 200 GeV and 6.4 for
+the 2.76 TeV run.

config/publications_config/arXiv_2011.01430/README.md

@@ -0,0 +1,3 @@
+# arXiv:2102.11337
+
+This XML file requires pre calculated hydro evolutions from file.