Welcome to pyirf’s documentation!

pyirf is a prototype for the generation of Instrument Response Functions (IRFs) for the Cherenkov Telescope Array (CTA). The package is being developed and tested by members of the CTA consortium and is a spin-off of the analog sub-process of the pipeline protopype.

Its main features are currently to

• find the best cutoff in gammaness/score, to discriminate between signal and background, as well as the angular cut to obtain the best sensitivity for a given amount of observation time and a given template for the source of interest (Cut Optimization)

• compute the instrument response functions, effective area, point spread function and energy resolution (Instrument Response Functions)

• estimate the sensitivity of the array (Sensitivity),

with plans to extend its capabilities to reach the requirements of the future observatory.

The source code is hosted on a GitHub repository, to which this documentation is linked.

Warning

This is not yet stable code, so expect large and rapid changes.

Citing this software

If you use a released version of this software for a publication, please cite it by using the corresponding DOI.

• latest :

• v0.5.0 :

• v0.4.0 :

Overview

• Installation
• Introduction to pyirf
• Examples
• Example Notebooks
• How to contribute
• Changelog
• Authors

API Documentation

• Instrument Response Functions
• Sensitivity
• Benchmarks
• Calculating and Applying Cuts
• Cut Optimization
• Simulation Information
• Event Weighting and Spectrum Definitions
• Statistics
• Binning and Histogram Utilities
• Input / Output
• Interpolation and Extrapolation of IRFs
• Gammapy Interoperability
• Utility functions

Indices and tables

• Index

• Module Index

• Search Page