eventdisplay_analysisscripts_vts

Scripts fo the Eventdisplay analysis for VERITAS

https://github.com/veritas-observatory/eventdisplay_analysisscripts_vts

Science Score: 62.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
    Organization veritas-observatory has institutional domain (veritas.sao.arizona.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords

eventdisplay
Last synced: 6 months ago · JSON representation ·

Repository

Scripts fo the Eventdisplay analysis for VERITAS

Basic Info
  • Host: GitHub
  • Owner: VERITAS-Observatory
  • License: bsd-3-clause
  • Language: Shell
  • Default Branch: main
  • Homepage:
  • Size: 1.03 MB
Statistics
  • Stars: 0
  • Watchers: 10
  • Forks: 1
  • Open Issues: 2
  • Releases: 22
Topics
eventdisplay
Created over 5 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

Eventdisplay Analysis Scripts for VERITAS

DOI License CI

Overview

This repository contains scripts for analyzing VERITAS data and MC simulations.

These scripts are part of the Eventdisplay packages and require additionally the following items installed:

The scripts are optimized for the DESY computing environment, utilizing HTCondor batch systems and apptainers.

Usage

Set the following environment variables:

  • $EVNDISPSYS: Path to the Eventdisplay installation (Eventdisplay package).
  • $EVNDISPSCRIPT: Path to the ./scripts directory of this repository (scripts directory).
  • $VERITAS_ANALYSIS_TYPE (recommended): Indicates the reconstruction methods applied, e.g., AP_DISP, NN_DISP.

Additional environment variables, especially useful for batch systems, can be found in ./scripts/set_environment.sh.

Submission commands for various batch systems are available in submissionCommands.dat. Modify these commands according to your local requirements.

Downloading Data from the VERITAS Database

Scripts for downloading run-wise information from the VERITAS database are available in ./scripts/db_scripts/README.md.

Producing Instrument Response Functions (IRFs)

IRFs are provided for each Eventdisplay release. The following instructions are for the IRF processing team.

Adding a New IRF Epoch

VERITAS IRFs are divided into epochs (e.g., summer/winter, throughput epochs, instrument stages like V4, V5, V6). Epochs are defined in ParameterFiles/VERITAS.Epochs.runparameter and should align with calibration throughput corrections (see internal VERITAS wiki page).

Throughput corrections are defined in ParameterFiles/ThroughputCorrection.runparameter.

Analysis scripts require a list of all V6 summer and winter periods, which are listed in IRFEPOCHSWINTER.dat and IRFEPOCHSSUMMER.dat. UV Filter IRF periods are defined in IRFEPOCHSobsfilter.dat. No changes to the analysis scripts are required, except for updating the help message (list of epochs) in ./IRF.production.sh.

Adding a new epoch usually requires re-running the mscw data analysis steps with updated lookup tables and dispBDTs, as these IRFs have changed. This step also updates the IRF flag in the mscw files.

MC Analysis - evndisp Stage

This stage requires the most computing resources and usually takes several days. MC simulation files are required in the directory structure outlined in ./scripts/IRF.production.sh.

Run the following steps for all analysis types (AP, NN):

bash ./IRF.generalproduction.sh CARE_RedHV_Feb2024 EVNDISP ./IRF.generalproduction.sh CARE_24_20 EVNDISP

Results are stored in $VERITAS_IRFPRODUCTION_DIR/<eventdisplay version>/AP/CARE_24_20/V6_2022_2023w_ATM61_gamma/. For DESY productions, the evndisp files should be moved to $VERITAS_IRFPRODUCTION_DIR/v4N/AP/CARE_24_20/V6_2022_2023w_ATM61_gamma/.

MC Analysis - Lookup Table Filling

Fill lookup tables per bin:

bash ./IRF.generalproduction.sh CARE_24_20 MAKETABLES

Then combine the tables with:

bash ./IRF.generalproduction.sh CARE_24_20 COMBINETABLES

Move the tables from $VERITAS_IRFPRODUCTION_DIR/<eventdisplay version>/${VERITAS_ANALYSIS_TYPE:0:2}/Tables to $VERITAS_EVNDISP_AUX_DIR/Tables.

MC Analysis - DispBDT Angular Reconstruction Training

bash ./IRF.generalproduction.sh CARE_24_20 TRAINMVANGRES

Copy and zip the files to $VERITAS_EVNDISP_AUX_DIR/DispBDTs:

bash cd $VERITAS_EVNDISP_AUX_DIR/DispBDTs ./copy_DispBDT.sh

(take care of any errors printed to the screen)

BDT Training

Preparation

Generate background training events using:

bash ./IRF.selectRunsForGammaHadronSeparationTraining.sh <major epoch> <source mscw directory> <target mscw directory> <TMVA run parameter file (full path)>

Use e.g. $VERITAS_DATA_DIR/processed_data_v491/AP/mscw/ for the source directory, which contains processed mscw files from observations. Main purpose is to select runs with good data quality and runs obtained from observations of strong gamma-ray sources.

This script links mscw files from the archive to a target directory sorted by epoch and zenith bins (read from TMVA run parameter file).

Training

(only for regular HV)

  • Use TRAINTMVA in ./IRF.generalproduction.sh, which calls the script IRF.trainTMVAforGammaHadronSeparation.sh.
  • Copy TMVA BDT files to $VERITAS_EVNDISP_AUX_DIR/GammaHadronBDTs using $VERITAS_EVNDISP_AUX_DIR/GammaHadronBDTs/copy_GammaHadron_V6_BDTs.sh (XML files are not zipped).

Requires as input:

  • TMVA.runparameter file
  • mscw files from observations (see above) for background events
  • mscw files from simulations for signal events

Cut Optimization

Cut optimization requires signal rates (from simulations) and background rates (from data). The $EVNDISPSYS/bin/calculateCrabRateFromMC tool is used to calculate rates after pre-selection cuts (note: set CALCULATERATEFILES="TRUE" in $EVNDISPSCRIPTS/helper_scripts/IRF.optimizeTMVAforGammaHadronSeparation_sub.sh).

Important: This script is not working in combination with the usage of apptainers.

  1. Generate effective areas for pre-selection cuts using PRESELECTEFFECTIVEAREAS.
  2. Generate background anasum files for pre-selection cuts. Use $EVNDISPSCRIPTS/ANALYSIS.anasum_allcuts.sh with the PRECUTS option to submit the corresponding jobs (use the same runs for background rate calculation as used for BDT training). These files should be moved into e.g. $VERITAS_IRFPRODUCTION_DIR/<eventdisplay version>/AP/BDTtraining/BackgroundRates/V6/NTel2-Moderate (adjust epoch and cut directory name).

Cut values are extracted by the optimization tool and written e.g., to

console VERITAS_IRFPRODUCTION_DIR/<eventdisplay version>/AP/BDTtraining/BackgroundRates/V6/Optimize-NTel2-Moderate/

Copy and paste those values into the files defining the gamma/hadron separation cuts in $VERITAS_EVNDISP_AUX_DIR/GammaHadronCuts.

Effective Area Generation

Effective area generation requires the MC-generated mscw files and well defined gamma/hadron cuts values in $VERITAS_EVNDISP_AUX_DIR/GammaHadronCuts.

bash ./IRF.generalproduction.sh CARE_24_20 EFFECTIVEAREAS

This generates effective areas per bin in parameter spaces. To combine the effective areas for a single file per cut and epcoh, run:

bash ./IRF.generalproduction.sh CARE_24_20 COMBINEEFFECTIVEAREAS

Move the generated effective areas files to $VERITAS_EVNDISP_AUX_DIR/EffectiveAreas.

Support

For any questions, contact Gernot Maier

License

EventdisplayAnalysisScriptsVTS is licensed under the BSD 3-Clause License - see the LICENSE file.

Owner

  • Name: VERITAS Observatory
  • Login: VERITAS-Observatory
  • Kind: organization

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 VERITAS"
doi: 10.5281/zenodo.6816986
version: 4.90.7.1
date-released: 2025-01-12
keywords:
- "gamma-ray astronomy"
- "astronomy software"
- "Imaging Atmospheric Cherenkov Telescope"
- VERITAS
- Eventdisplay
repository-code: https://github.com/VERITAS-Observatory/Eventdisplay_AnalysisScripts_VTS
license: BSD-3-Clause
authors:
- given-names: Gernot
  family-names: Maier
  affiliation: DESY
  orcid: https://orcid.org/0000-0001-9868-4700

GitHub Events

Total
  • Release event: 2
  • Delete event: 19
  • Issue comment event: 2
  • Push event: 119
  • Pull request review comment event: 5
  • Pull request review event: 12
  • Pull request event: 32
  • Create event: 21
Last Year
  • Release event: 2
  • Delete event: 19
  • Issue comment event: 2
  • Push event: 119
  • Pull request review comment event: 5
  • Pull request review event: 12
  • Pull request event: 32
  • Create event: 21

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • 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: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • steob92 (1)
  • GernotMaier (1)
Pull Request Authors
  • GernotMaier (39)
  • tobiaskleiner (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
v492 (1)