Welcome To HEAPY 👋

A unified toolkit for timing and spectral analysis of X-ray and gamma-ray transient data.

Prerequisites

HEASoft

Heapy will invoke certain software and commands from HEASoft, such as xselect and ximage. Please ensure that HEASoft is correctly installed on your system, and that the Calibration Database (CALDB) for the mission (e.g., Swift) you are processing is also properly installed.

Fermi GBM Response Generator

Heapy generates the response matrix files for Fermi GBM by invoking gbm_drm_gen. It is recommended to install my forked Python packages, which have been fine-tuned to resolve compatibility issues with newer versions of numpy and astropy, and to use TTE data instead of CSPEC data. The specific installation procedure is as follows:

$ git clone https://github.com/jyangch/responsum.git
$ pip3 install ./responsum

$ git clone https://github.com/jyangch/gbmgeometry.git
$ pip3 install ./gbmgeometry

$ git clone https://github.com/jyangch/gbm_drm_gen.git
$ pip3 install ./gbm_drm_gen

Installation

Heapy is available via pip:

$ pip3 install heapyx

Documentation

If you wish to learn about the usage, you may check the examples.

License

Heapy is distributed under the terms of the GPL-3.0 license.