Skip to main content

Compute and plot CTA IRFs

Project description

ctaplot provides low-level reconstruction quality-checks metrics computation and vizualisation for Imaging Atmospheric Cherenkov Telescopes such as CTA

Travis CI Documentation Status License: MIT https://mybinder.org/badge_logo.svg https://zenodo.org/badge/DOI/10.5281/zenodo.5833854.svg

You may find examples in the documentation and run them via mybinder.



The CTA instrument response functions data used in ctaplot come from the CTA Consortium and Observatory and may be found on the cta-observatory website .

In cases for which the CTA instrument response functions are used in a research project, we ask to add the following acknowledgement in any resulting publication:

“This research has made use of the CTA instrument response functions provided by the CTA Consortium and Observatory, see http://www.cta-observatory.org/science/cta-performance/ (version prod3b-v2) for more details.”


Install

Requirements packages:

  • python >= 3.9

  • numpy

  • scipy>=0.19

  • matplotlib>=3.6

  • astropy

Optional LaTeX dependencies for enhanced plot rendering:

  • A LaTeX distribution (e.g., TeX Live, MiKTeX)

  • dvipng (for PNG output)

  • cm-super (Computer Modern fonts)

Installation instructions:

On Ubuntu/Debian:

sudo apt-get install texlive-latex-base texlive-fonts-recommended dvipng cm-super

On macOS with Homebrew:

brew install --cask mactex
# dvipng and cm-super are included with MacTeX

On macOS with MacPorts:

sudo port install texlive +full

Note: LaTeX dependencies are optional. If not installed, ctaplot will automatically fall back to matplotlib’s default text rendering without LaTeX support.

We recommend the use of anaconda

The package is available through pip:

pip install ctaplot
export GAMMABOARD_DATA=path_to_the_data_directory

We recommend that you add this line to your bash source file ($HOME/.bashrc or $HOME/.bash_profile)

GammaBoard

A dashboard to show them all.

GammaBoard is a simple jupyter dashboard thought to display metrics assessing the reconstructions performances of Imaging Atmospheric Cherenkov Telescopes (IACTs). Deep learning is a lot about bookkeeping and trials and errors. GammaBoard ease this bookkeeping and allows quick comparison of the reconstruction performances of your machine learning experiments.

It is a working prototype used especially by the GammaLearn project.

Run GammaBoard

To launch the dashboard, you can simply try the command:

gammaboard

This will run a temporary copy of the dashboard (a jupyter notebook). Local changes that you make in the dashboard will be discarded afterwards.

GammaBoard is using data in a specific directory storing all your experiments files. This directory is known under $GAMMABOARD_DATA by default. However, you can change the path access at any time in the dashboard itself.

Demo

Here is a simple demo of GammaBoard:

  • On top the plots (metrics) such as angular resolution and energy resolution.

  • Below, the list of experiments in the user folder.

When an experiment is selected in the list, the data is automatically loaded, the metrics computed and displayed. A list of information provided during the training phase is also displayed. As many experiments results can be overlaid. When an experiment is deselected, it simply is removed from the plots.

gammaboard_demo

Cite

We would appreciate you cite the version of ctaplot you used using the corresponding Zenodo DOI that cound find here: https://doi.org/10.5281/zenodo.5833853

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ctaplot-0.6.5.tar.gz (4.3 MB view details)

Uploaded Source

File details

Details for the file ctaplot-0.6.5.tar.gz.

File metadata

  • Download URL: ctaplot-0.6.5.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ctaplot-0.6.5.tar.gz
Algorithm Hash digest
SHA256 319cf5334ceeee0666cc52c13f1267571a9af83c13caf1be895fcdc725147c95
MD5 14ca2a309528833cd0fd7b37ec8c870e
BLAKE2b-256 e3d8bf7d954a4cc87784d0c994456f77bd79935de0a5e9bdf43ea3efbef453f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page