docs/_documentation/faq.md

0001 ---
0002 title: FAQ
0003 description: FAQ
0004 name: faq
0005 layout: default
0006 ---
0007
0008 {% include layouts/title.md %}
0009
0010 The following documentation assumes that users have completed the basic training on the [ePIC landing page](https://eic.github.io/documentation/landingpage.html) or atleast have rudimentary understanding of the [eic-shell](https://eic.github.io/tutorial-setting-up-environment/02-eic-shell/index.html) container and [ROOT](https://root.cern.ch/) analysis package.
0011
0012 #### How to access input datasets and simulated results from Jefferson Lab xrootd (PREFERRED METHOD)
0013 First open `eic-shell` and connect to the xrootd filesystem
0014 ```
0015 xrdfs root://dtn-eic.jlab.org
0016 ```
0017 Then the relevant directories (EVGEN, RECO, and FULL) can be found in /work/eic2/EPIC directory
0018 ```
0019 [dtn-eic.jlab.org:1094] / > ls /work/eic2/EPIC
0020 /work/eic2/EPIC/EVGEN
0021 /work/eic2/EPIC/FULL
0022 /work/eic2/EPIC/RECO
0023 ....................
0024 ....................
0025 ```
0026 - EVGEN: hepmc3 rootfiles for input datasets
0027 - FULL: Full geant4 simulation root files
0028 - RECO: Reconstructed root files
0029
0030 The rootfiles are organized under the categories in tagged folders that correlate to the campaigns and detector configs. To list the directories and exit out of the filesystem:
0031 ```
0032 [dtn-eic.jlab.org:1094] / > ls /work/eic2/EPIC/RECO/23.06.1/epic_brycecanyon
0033 /work/eic2/EPIC/RECO/23.06.1/epic_brycecanyon/DIS
0034 /work/eic2/EPIC/RECO/23.06.1/epic_brycecanyon/SIDIS
0035
0036 [dtn-eic.jlab.org:1094] / > exit
0037 Goodbye.
0038 ```
0039 The preferred way to access a specific rootfile is to open it in root directly:
0040 ```
0041 auto f = TFile::Open("root://dtn-eic.jlab.org//work/eic2/EPIC/RECO/23.06.1/epic_brycecanyon/DIS/NC/18x275/minQ2=1/pythia8NCDIS_18x275_minQ2=1_beamEffects_xAngle=-0.025_hiDiv_5.1663.eicrecon.tree.edm4eic.root")
0042 ```
0043 N.B. The above command needs to be executed after opening root. Make sure to use `TFile::Open("filename")` because `new TFile("filename")` will not work. You can try doing `root "filename"` to load the file on startup.
0044
0045 It is also possible copy the file and open it locally:
0046 ```
0047 xrdcp root://dtn-eic.jlab.org//work/eic2/EPIC/RECO/23.06.1/epic_brycecanyon/DIS/NC/18x275/minQ2=1/pythia8NCDIS_18x275_minQ2=1_beamEffects_xAngle=-0.025_hiDiv_5.1663.eicrecon.tree.edm4eic.root .
0048 root pythia8NCDIS_18x275_minQ2=1_beamEffects_xAngle=-0.025_hiDiv_5.1663.eicrecon.tree.edm4eic.root
0049 ```
0050
0051
0052 #### How to access input datasets and simulated results from BNL S3
0053 This method should not be used unless you cannot find what you need in xrootd. The S3 and xrootd servers are synced but sometimes there may be lags. If it is not time-critical, give it a day and check again on xrootd before trying this.
0054 ##### Install minio client
0055 ```
0056 mkdir --parent ~/bin
0057 curl https://dl.min.io/client/mc/release/linux-amd64/mc --create-dirs -o ~/bin/mc
0058 chmod +x ~/bin/mc
0059 ```
0060 ##### Setup read permissions (Only do this once)
0061 To get credential, contact production WG on mattermost.
0062 ```
0063 ~/bin/mc config host add S3 https://eics3.sdcc.bnl.gov:9000 <credential> <credential>
0064 ```
0065 ##### To view content
0066 ```
0067 ~/bin/mc ls S3/eictest/EPIC
0068 ```
0069 Example output from the above command:
0070 ```
0071 [2023-07-06 00:33:40 CDT]    38B STANDARD _condor_stderr
0072 [2023-07-06 00:33:40 CDT] 537KiB STANDARD _condor_stdout
0073 [2023-07-06 10:19:56 CDT]     0B Campaigns/
0074 [2023-07-06 10:19:56 CDT]     0B EVGEN/
0075 [2023-07-06 10:19:56 CDT]     0B FULL/
0076 [2023-07-06 10:19:56 CDT]     0B LOG/
0077 [2023-07-06 10:19:56 CDT]     0B RECO/
0078 [2023-07-06 10:19:56 CDT]     0B Tutorials/
0079 [2023-07-06 10:19:56 CDT]     0B spack/
0080 [2023-07-06 10:19:56 CDT]     0B users/
0081 ```
0082 The full GEANT4 simulation outputs ran for small number of datasets can be found inside the FULL directory with campaign tags
0083 ```
0084  ~/bin/mc ls S3/eictest/EPIC/FULL
0085 ```
0086 Example output from the above command
0087 ```
0088 [2023-07-06 10:46:37 CDT]     0B 23.03.0/
0089 [2023-07-06 10:46:37 CDT]     0B 23.05.2/
0090 [2023-07-06 10:46:37 CDT]     0B 23.06.0/
0091 [2023-07-06 10:46:37 CDT]     0B 23.06.1/
0092 [2023-07-06 10:46:37 CDT]     0B main/
0093 ```
0094 If you want to check what results exist for a particular tagged campaign, you can use the tree command
0095 ```
0096 ~/bin/mc tree S3/eictest/EPIC/FULL/23.06.1
0097 ```
0098 This produces the following output
0099 ```
0100 S3/eictest/EPIC/FULL/23.06.1
0101 └─ epic_brycecanyon
0102    ├─ DIS
0103    │  └─ NC
0104    │     ├─ 10x100
0105    │     │  └─ minQ2=10
0106    │     ├─ 18x275
0107    │     │  └─ minQ2=10
0108    │     └─ 5x41
0109    │        └─ minQ2=10
0110    └─ SIDIS
0111       └─ pythia6
0112          ├─ ep_10x100
0113          │  └─ hepmc_ip6
0114          │     └─ noradcor
0115          ├─ ep_18x275
0116          │  └─ hepmc_ip6
0117          │     └─ noradcor
0118          └─ ep_5x41
0119             └─ hepmc_ip6
0120                └─ noradcor
0121 ```
0122
0123 The location of the input hepmc3.tree.root files that were used to run the simulations can be found inside EVGEN in the location as listed in the associated csv file in ![campaign datasets](https://github.com/eic/simulation_campaign_datasets) github repo.
0124 ![image](https://github.com/eic/epic-prod/assets/7409132/e282c9ee-a17e-488c-8793-ea52d29eb562)
0125
0126 The reconstructed outputs can be found in similar tagged sub-folders inside the RECO folder.
0127 ```
0128 ~/bin/mc ls S3/eictest/EPIC/RECO
0129 ```
0130 Example output from above command
0131 ```
0132 [2023-07-06 10:57:37 CDT]     0B 22.10.0/
0133 [2023-07-06 10:57:37 CDT]     0B 22.11.0/
0134 [2023-07-06 10:57:37 CDT]     0B 22.11.2/
0135 [2023-07-06 10:57:37 CDT]     0B 22.11.3/
0136 [2023-07-06 10:57:37 CDT]     0B 22.12.0/
0137 [2023-07-06 10:57:37 CDT]     0B 23.01.0/
0138 [2023-07-06 10:57:37 CDT]     0B 23.03.0/
0139 [2023-07-06 10:57:37 CDT]     0B 23.05.1/
0140 [2023-07-06 10:57:37 CDT]     0B 23.05.2/
0141 [2023-07-06 10:57:37 CDT]     0B 23.06.0/
0142 [2023-07-06 10:57:37 CDT]     0B 23.06.1/
0143 [2023-07-06 10:57:37 CDT]     0B alternative-geometries-img-ecal/
0144 [2023-07-06 10:57:37 CDT]     0B main/
0145 ```
0146 Example of copying a file to your local machine
0147 ```
0148 ~/bin/mc cp S3/eictest/EPIC/RECO/23.06.1/epic_brycecanyon/DIS/NC/5x41/minQ2=1/pythia8NCDIS_5x41_minQ2=1_beamEffects_xAngle=-0.025_hiDiv_vtxfix_5.0386.eicrecon.tree.edm4eic.root .
0149 ```
0150
0151
0152
0153
0154
0155
0156
0157
0158
0159
0160