Metadata-Version: 2.4
Name: heapyx
Version: 0.2.0
Summary: High-energy (X-ray and gamma-ray) astronomical data analysis tools
Home-page: https://github.com/jyangch/heapy
Author: Jun Yang
Author-email: jyang@smail.nju.edu.cn
License: GPLv3
Project-URL: Source Code, https://github.com/jyangch/heapy
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.20.4
Requires-Dist: pandas>=1.4.2
Requires-Dist: scipy>=1.8.0
Requires-Dist: astropy>=5.2.2
Requires-Dist: matplotlib>=3.2.1
Requires-Dist: tqdm>=4.64.1
Requires-Dist: plotly>=5.22.0
Requires-Dist: pybaselines>=1.1.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# *Welcome* *To* *HEAPY* 👋

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

[![PyPI - Version](https://img.shields.io/pypi/v/heapyx?color=blue&logo=PyPI&logoColor=white&style=for-the-badge)](https://pypi.org/project/heapyx/)
[![License: GPL v3](https://img.shields.io/github/license/jyangch/heapy?color=blue&logo=open-source-initiative&logoColor=white&style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0)


## Prerequisites

### HEASoft

_Heapy_ will invoke certain software and commands from HEASoft, such as `xselect` and `ximage`. Please ensure that [`HEASoft`](https://heasarc.gsfc.nasa.gov/docs/software/heasoft/#install) is correctly installed on your system, and that the [`Calibration Database`](https://heasarc.gsfc.nasa.gov/docs/heasarc/caldb/install.html) (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`](https://github.com/grburgess/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:
```bash
$ 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`:
```bash
$ pip3 install heapyx
```
**NOTE**: The package name of _heapy_ in pypi is registered as `heapyx` rather than `heapy`, as the latter has already been taken.


## Documentation

If you wish to learn about the usage, you may check the [`examples`](https://github.com/jyangch/heapy/tree/main/examples).


## License

_Heapy_ is distributed under the terms of the [`GPL-3.0`](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
