eventdisplay_v4

A reconstruction and analysis pipeline for VERITAS.

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

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: arxiv.org, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.8%) to scientific vocabulary

Keywords

eventdisplay
Last synced: 6 months ago · JSON representation ·

Repository

A reconstruction and analysis pipeline for VERITAS.

Basic Info
  • Host: GitHub
  • Owner: VERITAS-Observatory
  • License: bsd-3-clause
  • Language: C++
  • Default Branch: main
  • Homepage:
  • Size: 11.5 MB
Statistics
  • Stars: 6
  • Watchers: 13
  • Forks: 1
  • Open Issues: 3
  • Releases: 47
Topics
eventdisplay
Created over 6 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Eventdisplay: An Analysis and Reconstruction Package for VERITAS

DOI ASCL License CI

Overview

Eventdisplay is a reconstruction and analysis pipeline for data of Imaging Atmospheric Cherenkov Telescopes. It has been primarily developed for the analysis of VERITAS and CTAO data to generate results for scientific publications. This repository contains the Eventdisplay version used for VERITAS analysis (CTAO version)

In case Eventdisplay is used in a research project, please cite this repository using the Zenodo entry and the following publication:

text Maier, G.; Holder, J., Eventdisplay: An Analysis and Reconstruction Package for Ground-based Gamma-ray Astronomy, 35th International Cosmic Ray Conference. 10-20 July, 2017. Bexco, Busan, Korea, Proceedings of Science, Vol. 301. Online at [https://pos.sissa.it/cgi-bin/reader/conf.cgi?confid=301], id.747 [https://arxiv.org/abs/1708.04048]

The package consists of several analysis steps and tools:

  1. evndisp: calibrate and parametrize images, event reconstruction, stereo analysis
  2. trainTMVAforAngularReconstruction: train boosted decision trees for direction and energy reconstruction
  3. mscw_energy: fill and use lookup tables for mean scaled with and length calculation, energy reconstruction, stereo reconstruction
  4. trainTMVAforGammaHadronSeparation: train boosted decision trees for gamma/hadron separation
  5. makeEffectiveArea: calculation of the instrument response functions (effective areas, angular point-spread function, energy resolution)
  6. makeRadialAcceptance: calculation of radial camera acceptance from data files
  7. anasum: analysis to calculate sky maps and spectral energy distribution
  8. libVAnaSum: shared library tools (e.g., plot instrument response function, spectral energy distributions, light curves, sky maps

Releases

Check the release pages for the most recent versions to be used for VERITAS publications. For older versions of Eventdisplay, see the release pages on the VERITAS wiki (internal pages).

The Eventdisplay Ecosystem

Reconstruction and analysis are complex and require inputs from different sources and execution of several interdependent stages.

Eventdisplay consists of the following main components:

  • Eventdisplay: the core library with code, tools, and analysis libraries required to run the analysis
  • EventdisplayAnalysisScriptsVTS: a library of scripts to use Eventdisplay efficiently on a computing cluster
  • EventdisplayAnalysisFilesVTS: a set of auxiliary files with information on the instrument (e.g., telescope positions), access information to data bases, parameters for the analysis (e.g., image cleaning parameters or instruction for the gamma/hadron separation), or basic calibration values (note that this is a VERITAS private repository)
  • V2DL3: a converter of Eventdisplay data products to GADF DL3 Format to be used in science tools like gammapy.
  • Eventdisplay_Preprocessing: Documentation and scripts related to the pre-processing all VERITAS observations with Eventdisplay.

Additional components:

Documentation

Extensive documentation on how to use Eventdisplay are available through the VERITAS internal wiki pages.

Support

  • VERITAS internal ELOG used for announcements, discussions, questions
  • Bugs and issues should be reported through the GitHub issue tracker

For any questions, contact Gernot Maier.

Development

astyle is used for source code formatting since 03/2014 http://astyle.sourceforge.net/

Usage:

do either

console make formatSourceCode

or

console astyle --options=./.astylerc <.cpp, .h or .C file>

All options are saved in the .astylerc file.

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: an Analysis and Reconstruction Package for VERITAS"
doi: 10.5281/zenodo.6827832
version: 4.91.0
date-released: 2024-11-30
keywords:
- "gamma-ray astronomy"
- "astronomy software"
- "Imaging Atmospheric Cherenkov Telescope"
- VERITAS
- Eventdisplay
repository-code: https://github.com/VERITAS-Observatory/EventDisplay_v4
license: BSD-3-Clause
authors:
- given-names: Gernot
  family-names: Maier
  affiliation: DESY
  orcid: https://orcid.org/0000-0001-9868-4700
- given-names: Jamie
  family-names: Holder
  affiliation: "Department of Physics and Astronomy and the Bartol Research Institute, University of Delaware, Newark, DE 19716, USA"
# Many people contributed to the software. If you've been left off, please email to Gernot Maier.
- given-names: A.
  family-names: McCann
- given-names: B.
  family-names: Behera
- given-names: C.
  family-names: Duke
- given-names: C.
  family-names: Giuri
- given-names: C.
  family-names: Skole
- given-names: D.
  family-names: Tak
- given-names: E.
  family-names: Aliu
- given-names: E.
  family-names: Pueschel
- given-names: F.
  family-names: Pizlo
- given-names: G.
  family-names: Decerpri
- given-names: G.
  family-names: Finneagan
- given-names: G.
  family-names: Foote
- given-names: G.
  family-names: Hughes
- given-names: H.
  family-names: Fleischhack
- given-names: H.
  family-names: Krawczynski
- given-names: H.
  family-names: Prokoph
- given-names: J.
  family-names: Grube
- given-names: J.
  family-names: Tyler
- given-names: K.
  family-names: Berger
- given-names: K.
  family-names: Pfrang
- given-names: L.
  family-names: Gerard
- given-names: M.
  family-names: Beilicke
- given-names: M.
  family-names: Kherlakian
- given-names: M.
  family-names: Krause
- given-names: M.
  family-names: McCutcheon
- given-names: M.
  family-names: Nievas-Rosillo
- given-names: M.
  family-names: Schroedter
- given-names: M.
  family-names: Shayduk
- given-names: N.
  family-names: Hakasson
- given-names: N.
  family-names: Kelley-Hoskins
- given-names: O.
  family-names: Gueta
- given-names: P.
  family-names: Ivo
- given-names: R.
  family-names: Guenette
- given-names: S.
  family-names: Patel
- given-names: R.
  family-names: Prado
- given-names: R.
  family-names: Welsing
- given-names: S.
  family-names: Griffin
- given-names: S.
  family-names: Griffiths
- given-names: S.
  family-names: "O'Brian"
- given-names: S.
  family-names: Vincent
- given-names: S.
  family-names: Vorobiov
- given-names: T.
  family-names: Hassan
- given-names: Y.
  family-names: Khassen

GitHub Events

Total
  • Create event: 32
  • Issues event: 4
  • Release event: 5
  • Watch event: 2
  • Delete event: 21
  • Issue comment event: 4
  • Push event: 108
  • Pull request review comment event: 7
  • Pull request review event: 16
  • Pull request event: 49
Last Year
  • Create event: 32
  • Issues event: 4
  • Release event: 5
  • Watch event: 2
  • Delete event: 21
  • Issue comment event: 4
  • Push event: 108
  • Pull request review comment event: 7
  • Pull request review event: 16
  • Pull request event: 49

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 11
  • Average time to close issues: 19 days
  • Average time to close pull requests: about 15 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 2
  • Pull requests: 11
  • Average time to close issues: 19 days
  • Average time to close pull requests: about 15 hours
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • GernotMaier (4)
  • steob92 (1)
Pull Request Authors
  • GernotMaier (39)
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2) github_actions (1)

Dependencies

.github/workflows/ci-buildmatrix-cpp11.yml actions
  • actions/checkout v4 composite
.github/workflows/ci-buildmatrix-cpp17.yml actions
  • actions/checkout v4 composite
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
.github/workflows/vts-eventdisplay-package.yml actions
  • actions/checkout v4 composite
  • docker/build-push-action v5 composite
  • docker/login-action v3 composite
  • docker/metadata-action v5 composite
dockerfiles/Dockerfile docker
  • rootproject/root ${ROOT_VERSION} build