eventdisplay_analysisscripts_cta
Scripts fo the Eventdisplay analysis for CTA
https://github.com/eventdisplay/eventdisplay_analysisscripts_cta
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.5%) to scientific vocabulary
Repository
Scripts fo the Eventdisplay analysis for CTA
Basic Info
- Host: GitHub
- Owner: Eventdisplay
- License: bsd-3-clause
- Language: Shell
- Default Branch: main
- Size: 636 KB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
- Releases: 15
Metadata Files
README.md
Eventdisplay Analysis Scripts for CTA
Run scripts for CTA. Allows to efficiently run all analysis steps starting from the raw MC files to sensitivities using Eventdisplay.
Installation
Directories
All scripts expect the following setup for directories. Any deviation from this will break the scripts.
Main directory for all analysis products:
console
${CTA_USER_DATA_DIR}/analysis/AnalysisData/${DSET}
Main directory for all software and auxilaury files plus all log files from the analysis:
console
${CTA_USER_WORK_DIR}/analysis/AnalysisData/${DSET}
$DSET is the name of the data set to be analysed, e.g. prod3b-paranal20deg_SCT-sq08-LL.
The following subdirectories are expected:
- ${CTAUSERWORKDIR}/analysis/AnalysisData/EventdisplayAnalysisScripts_CTA - the directory with this repository
- ${CTAUSERDATADIR}/analysis/AnalysisData/FileListprod3b - directory with the lists for the simulation files (see below)
- ${CTAUSERDATA_DIR}/analysis/AnalysisData/{DSET} - the directory with all analysis products (several subdirectories will be prepared from the analysis scripts)
- ${CTAUSERWORK_DIR}/analysis/AnalysisData/{DSET} - the directory with all and auxiliary files
Installation of scripts and Eventdisplay
Requires root to be installed and $ROOTSYS to be set (use ROOT versions >=6.20)
Install EventdisplayAnalysisScriptsCTA from github and select the corresponding branch to work with (e.g., prod5-v08):
console
git clone https://github.com/Eventdisplay/Eventdisplay_AnalysisScripts_CTA.git
cd Eventdisplay_AnalysisScripts_CTA
git checkout prod5-v08
Install and compile eventdisplay (expect all Eventdisplay repositories with same branch names):
console
cd install
./prepareProductionBinaries.sh <data set> prod5-v08
This installs the following packages:
- hessioxx
- sofa
- Eventdisplay analysis files
- Eventdisplay code
Note that only the data set name needs to be given here (e.g., prod3b-paranal20deg_SCT-sq08-LL), and not a full path name.
Path setting
Before running any scripts, the correct paths for all executables and libraries needs to be set.
console
cd ${CTA_USER_DATA_DIR}/analysis/AnalysisData/Eventdisplay_AnalysisScripts_CTA
source ./setSoftwarePaths.sh ${DSET}
List of MC files for the evndisp stage
For the first stage of the analysis, a list with file names (full paths) for all MC input files needs to be filled.
Expected directory structure (first level):
- prod3b: ${CTAUSERDATADIR}/analysis/AnalysisData/FileListprod3b/
- prod5: ${CTAUSERDATADIR}/analysis/AnalysisData/FileListprod5/
Second level directory structure expects a substring of ${DSET} (without the analysis version number). E.g. for the example of prod3b-paranal20deg_SCT-sq08-LL, it should be only prod3b-paranal20deg_SCT.
In this directory, the list of files for the different particle types are:
- gamma_cone.list
- gamma_onSource.list
- electron.list
- proton.list
e.g.,
console
/lustre/fs24/group/cta/prod3b/CTA-ProdX-Download-DESY/Prod3b_Paranal_20deg_HB9//electron/electron_20deg_0deg_run945___cta-prod3-sct_desert-2150m-Paranal-SCT.simtel.gz
/lustre/fs24/group/cta/prod3b/CTA-ProdX-Download-DESY/Prod3b_Paranal_20deg_HB9//electron/electron_20deg_0deg_run2962___cta-prod3-sct_desert-2150m-Paranal-SCT.simtel.gz
/lustre/fs24/group/cta/prod3b/CTA-ProdX-Download-DESY/Prod3b_Paranal_20deg_HB9//electron/electron_20deg_180deg_run2634___cta-prod3-sct_desert-2150m-Paranal-SCT.simtel.gz
/lustre/fs24/group/cta/prod3b/CTA-ProdX-Download-DESY/Prod3b_Paranal_20deg_HB9//electron/electron_20deg_180deg_run4722___cta-prod3-sct_desert-2150m-Paranal-SCT.simtel.gz
/lustre/fs24/group/cta/prod3b/CTA-ProdX-Download-DESY/Prod3b_Paranal_20deg_HB9//electron/electron_20deg_0deg_run2762___cta-prod3-sct_desert-2150m-Paranal-SCT.simtel.gz
Running the analysis
Central execution scripts are CTA.mainRunScriptsReduced.sh and CTA.runAnalysis.sh. In the best case, no changes are required to these scripts.
e.g., to run the first step of the analysis with evndisp, do
console
./CTA.mainRunScriptsReduced.sh prod6-Paranal-20deg-dark-sq10-LL EVNDISP
(or set any other data set, as outlined in ./CTA.mainRunScriptsReduced.sh)
To submit script, check the log file directory printed to the screen (the directory with the UUID) and then run:
console
./utilities/submit_scripts_to_htcondor.sh <log file directory> submit
Try this first without the submit argument and check the submit.txt file.
This assumes the HTCondor job submission system. Gridengine will work after changing the variable SUBC from condor to qsub in the scripts analysis/*sub*.
The script ./CTA.mainRunScriptsReduced.sh does the following:
- read a list of arrays from a subdirectory specified for your data set in ./CTA.runAnalysis.sh (e.g., prod3b/subArray.prod3b.South-SCT.list)
- execute scripts to submit jobs from the ./analysis directory
- all output products are written to ${CTAUSERDATA_DIR}/analysis/AnalysisData/${DSET}
- for all telescope multiplicity dependent analysis, this is done for the multiplicities defined in
NIM-South.datandNIM-South-sub.dat.
On the list of arrays:
- arrays are defined by the telescope numbering as defined during the simulations.
- array layout definition files can be found in $$CTAEVNDISPAUX_DIR}/DetectorGeometry
For a complete analysis, one needs to cycle through all reconstruction steps in the following sequence:
- EVNDISP - calibration and image analysis
- MAKETABLES and DISPBDT - lookup table filling and disp BDT training (can be done in parallel)
- ANATABLES - stereo analysis using lookup tables and disp BDTs
- PREPARETMVA - write data products needed for BDT training
- TRAIN - train BDTs for gamma/hadron separation
- ANGRES - determine angular resolution for 40% signal efficiency
- QC - determine data rates after quality cuts (used for cut optimisation)
- CUTS - optimise gamma/hadron cuts and calculate instrument response functions
- PHYS - fill instrument response functions
Testing
Running the analysis is complex and involves the reading and creating of many files (possibly >100k files). Testing the results for consistent is important; please look into the testProduction directory for testing scripts.
Utilities
Set links to EVNDISP production directory:
console
cd utitilities
./linkEvndispProduction.sh prod5-LaPalma-20deg-EVNDISP prod5-LaPalma-20deg-v02-LL ../prod5/subArray.prod5.North-noHyper-N.list
Set links for hyper array analysis:
console
cd utiltities
./prepareHyperProduction.sh prod5-LaPalma-20deg-v01-LL prod5-LaPalma-20deg-h01-LL ../prod5/subArray.prod5.North-noHyper.list
Count number of files in production directories:
console
cd utilities
./countFilesinProduction.sh prod5-LaPalma-20deg-EVNDISP ../prod5/subArray.prod5.North-noHyper.list EVNDISP
e.g., cross checks that number of EVNDISP files is correct
License
License: BSD-3 (see LICENSE file)
Contact
Gernot Maier
Owner
- Name: Eventdisplay
- Login: Eventdisplay
- Kind: organization
- Website: https://github.com/Eventdisplay/Eventdisplay_Documentation/blob/main/README.md
- Repositories: 7
- Profile: https://github.com/Eventdisplay
A reconstruction and analysis pipeline for ground-based imaging atmospheric Cherenkov Telescopes.
Citation (CITATION.cff)
# YAML 1.2
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: "Eventdisplay Analysis Scripts for CTA"
abstract: "Run scripts for CTA. Allows to efficiently run all analysis steps starting from the raw MC files to sensitivities using Eventdisplay."
doi: "https://doi.org/10.5281/zenodo.4263710"
version: 2.1.0
date-released: 2024-08-18
keywords:
- "gamma-ray astronomy"
- "astronomy software"
- "Imaging Atmospheric Cherenkov Telescope"
- VERITAS
- CTA
- "Cherenkov Telescope Array"
- Eventdisplay
repository-code: https://github.com/Eventdisplay/Eventdisplay_AnalysisScripts_CTA
license: BSD-3-Clause
authors:
- given-names: Gernot
family-names: Maier
affiliation: DESY
orcid: https://orcid.org/0000-0001-9868-4700
- given-names: Orel
family-names: Gueta
affiliation: DESY
references:
- scope: "Additional material"
type: article
title: "Eventdisplay: An Analysis and Reconstruction Package for Ground-based Gamma-ray Astronomy"
authors:
- family-names: Maier
given-names: Gernot
affiliation: DESY
- family-names: Holder
given-names: Jamie
affiliation: "Department of Physics and Astronomy and the Bartol Research Institute, University of Delaware, Newark, DE 19716, USA"
doi: 10.48550/arXiv.1708.04048
url: "https://arxiv.org/abs/1708.04048"
year: 2017
GitHub Events
Total
- Release event: 2
- Delete event: 9
- Push event: 39
- Pull request event: 17
- Create event: 11
Last Year
- Release event: 2
- Delete event: 9
- Push event: 39
- Pull request event: 17
- Create event: 11
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 12
- Average time to close issues: N/A
- Average time to close pull requests: 24 days
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: about 7 hours
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- GernotMaier (1)
Pull Request Authors
- GernotMaier (13)
- orelgueta (1)