Skip to main content

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

Metadata

Release files for ctaplot 0.6.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ctaplot 0.6.6
File Size Uploaded
ctaplot-0.6.6.tar.gz 4.3 MB Details

Release files / ctaplot-0.6.6.tar.gz

Download URL ctaplot-0.6.6.tar.gz
Size 4.3 MB
Tags Source
SHA-256 checksum
How to use checksums
72f99bc06460e5664149c027514a46814b753b303d6731117eaf1c3b516efbc4
BLAKE2b-256 checksum
How to use checksums
45feecec55691309be637f54325c573ec78be5c82fabd174fdea90949fb456c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.6.6 This release

1 release file

0.6.5

1 release file

0.6.4

1 release file

0.6.3

1 release file

0.6.2

1 release file

0.6.1

1 release file

0.5.6

1 release file

0.5.5

1 release file

0.5.3

1 release file

0.5.2

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page