Back to home page

EIC code displayed by LXR

 
 

    


Warning, /epic.github.io/_sc/faq.md is written in an unsupported language. File is not indexed.

0001 ---
0002 title: ePIC Software FAQ
0003 description: ePIC Software FAQ
0004 name: faq
0005 layout: default
0006 ---
0007 
0008 <h4>ePIC Software FAQ</h4>
0009 
0010 
0011 
0012 Welcome to the **Frequently Asked Questions** page!
0013 
0014 * Please use the helpdesk: [https://chat.epic-eic.org/](https://chat.epic-eic.org/){:target="_blank"} on Mattermost for urgent correspondence.
0015 * Submit new questions and comments by email to the relevant list: [epic-sc-faq-l@lists.bnl.gov](mailto:epic-sc-faq-l@lists.bnl.gov).
0016 
0017 ---
0018 
0019 <h4>List of Q/A</h4>
0020 
0021 * TOC
0022 {:toc}
0023 
0024 ---
0025 
0026 ##### Q: How can we browse the simulation output from a specific campaign and locate certain output files?
0027 **A:** Visit the [epicprod website](https://eic.github.io/epic-prod/campaigns/campaigns_reco.html)
0028 to view the list of avaiable campaigns. Pick a campaign that you want to view in detail.
0029 For example: [23.12.0](https://eic.github.io/epic-prod/RECO/23.12.0/).
0030 Here, you will find the output directories listed in a nested tree structure. The directory nomenclature usually follows the pattern:
0031 ```
0032     <base directory>/<campaign tag>/<detector config>/<physics processes>/<generator release tag if available>/<electron momentum>x<proton momentum>/<q2 range>/
0033 ```
0034 
0035 The preferred method to list the files in a directory is to use the xrdfs interface within eic-shell container. For example:
0036 ```
0037     xrdfs root://dtn-eic.jlab.org   
0038     ls /work/eic2/EPIC/RECO/23.09.1/epic_craterlake/DIS/NC/18x275/minQ2=1000
0039 ```
0040 See more details [here](https://eic.github.io/epic-prod/documentation/faq.html){:target="_blank"}.
0041 
0042 ---
0043 
0044 ##### Q: What input datasets are used in a particular production campaign and where can I find them?
0045 **A:** The directory structure of the input datasets mimic the directory structure of the output files from `<physics processes>` onwards. Consider, the output files under `root://dtn-eic.jlab.org//work/eic2/EPIC/RECO/23.12.0/epic_craterlake/DIS/NC/10x100/minQ2=1`. The corresponding input datasets can be found in the following manner:
0046 
0047 ```
0048     xrdfs root://dtn-eic.jlab.org
0049     ls /work/eic2/EPIC/EVGEN/DIS/NC/10x100/minQ2=1
0050 ```
0051 
0052 ---
0053 
0054 ##### Q: What is the procedure to introduce a new dataset into a production campaign or replace an existing one?
0055 **A:** Follow the input dataset creation [guidelines](https://eic.github.io/epic-prod/documentation/input_preprocessing.html){:target="_blank"} listed in the epic-prod website.
0056 
0057 ---
0058 
0059 ##### Q: How can we load files into ROOT directly from xrootd?
0060 **A:** Enter the full file path including server address using root TFile::Open. For example:
0061 ```
0062     auto f = TFile::Open("root://dtn-eic.jlab.org//work/eic2/EPIC/RECO/23.12.0/epic_craterlake/DIS/NC/18x275/minQ2=1000/pythia8NCDIS_18x275_minQ2=1000_beamEffects_xAngle=-0.025_hiDiv_1.0000.eicrecon.tree.edm4eic.root")
0063 ```
0064 See more details [here](https://eic.github.io/epic-prod/documentation/faq.html){:target="_blank"}.
0065 
0066 ---
0067 
0068 ##### Q: How can we copy files from xrootd?
0069 **A:** Use xrdcp with full path and local destination directory. For example:
0070 
0071 ```
0072 xrdcp root://dtn-eic.jlab.org//work/eic2/EPIC/RECO/23.12.1/epic_craterlake/DIS/NC/18x275/minQ2=1000/pythia8NCDIS_18x275_minQ2=1000_beamEffects_xAngle=-0.025_hiDiv_1.0000.eicrecon.tree.edm4eic.root <local destination>
0073 ```
0074 
0075 ---
0076 
0077 ##### Q: What is included in the campaign, and what are the major changes compared to before?
0078 **A:** We version track the [epic](https://github.com/eic/epic/releases){:target="_blank"} and [eicrecon](https://github.com/eic/eicrecon/releases){:target="_blank"}
0079 repositories and the new features introduced in a campaign are tracked in the release notes.
0080 For example: [epic-23.12.0](https://github.com/eic/epic/releases/tag/23.12.0){:target="_blank"} represents the software
0081 changes introduced in December campaign. As of December, 2023 we have also began enforcing version tracking on our input datasets.
0082 
0083 ---
0084 
0085 ##### Q: How can we effectively use the information stored in EICRecon rootfile outputs, such as matching reconstructed particles to their MC particles?
0086 **A:** To an extent, this is covered in the [dRICH tutorials](https://github.com/eic/drich-dev/blob/tutorial/doc/tutorials/3-running-reconstruction.md){:target="_blank"}, starting at session 3 and partly covered in existing [recorded tutorials](https://indico.bnl.gov/event/18373/){:target="_blank"}. _TODO:_ Probably needs to be supplemented with example codes.
0087 
0088 ---
0089 
0090 ##### Q: How can we apply beam effects, including adjusting the ion beam when using a particle gun?
0091 **A:** Beam effects are handled by the [afterburner](https://github.com/eic/afterburner){:target="_blank"}, which expects HepMC3 input. They cannot be simply turned on in just the npsim particle gun.
0092 
0093 ---
0094 
0095 ##### Q: How do we check and change beam magnet settings for both simulation and reconstruction?
0096 **A:**  _TODO:_ Changing magnet configuration in reconstruction makes little sense. Checking and changing it for simulation should be answered by the prod group.
0097 
0098 ---
0099 
0100 ##### Q: What is the best practice for analyzing EICrecon output, especially regarding hadron PID likelihoods?
0101 
0102 **A:**  _TODO:_ Needs an updated analysis tutorial. I don't believe at this point we have a simple unified PID likelihood approach.
0103 
0104 ---
0105 
0106 ##### Q: How can we develop a benchmark for an analysis code to pass on to the validation software team?
0107 
0108 **A:** _TODO:_ We originally planned a dedicated "Tutorial: Writing physics benchmarks that run automatically and reproducibly" - this needs to be revisited. Otherwise, Dmitry K, Wouter, Sylvester may be able to write up something short. This is a good FAQ candidate really, if we can get this answered.
0109 
0110 ---
0111 
0112 ##### Q: How can we access various (SI)DIS variables through different reconstruction methods?
0113 
0114 **A:** _TODO:_ Things like ``InclusiveKinematicsDA.cc`` are part of EicRecon, but I don't know how to use it. I don't believe it's calculated by default during campaigns, so one would still need an analysis level version. Would be good example analysis code, and I'm sure it exists in many forms on various people's laptops.
0115 
0116 ---
0117 
0118 ##### Q: How do we match tracks and clusters from the calorimeters?
0119 
0120 ---
0121 
0122 ##### Q: How can we access hadron and electron PID data?
0123 
0124 ---
0125 
0126 ##### Q: How do we navigate from reconstructed to truth information?
0127 
0128 **A:** Needs a refreshed tutorial; needs example code
0129 
0130 ---
0131 
0132 ##### Q: Is there an organized repository or wiki that guides newcomers to the right tutorials and slides?
0133 
0134 **A:** Yes, but the dRICH one is closest, plus the tutorials indico. _TODO:_ Should be combined and front and center of the landing page.
0135 
0136 ---
0137 
0138 ##### Q: Are there quick starter-code examples (Analyzer macros) for accessing branch information and creating physics plots?
0139 
0140 **A:** _TODO:_ Yes, but not well organized and more is better.
0141 
0142 ---
0143 
0144 ##### Q: Can you provide an example of analyzing EICrecon data using basic methods?
0145 **A:** [https://indico.bnl.gov/event/18373/](https://indico.bnl.gov/event/18373/){:target="_blank"} has some, so does the dRICH tutorial. _TODO:_ Needs more example code.