Installation Instructions

Prerequisites

You’ll need a recent python 3.11+ installation. The main dependency is

  1. Stingray,

which in turn depends on

  1. Numpy;

  2. Matplotlib;

  3. Scipy;

  4. Astropy

Optional but recommended dependencies are:

6. the netCDF 4 library with its python bindings;

  1. Numba;

  2. pint

You should also have a working HEASoft installation to produce the cleaned event files and to use XSpec.

Installing releases

$ pip install hendrics

The optional dependencies above are grouped into two extras, so that they do not have to be listed by hand:

$ pip install "hendrics[recommended]"

for numba and h5py, or

$ pip install "hendrics[all]"

which adds netcdf4, pint-pulsar, pandas, imageio and scikit-image. Note the quotes: without them the shell reads the square brackets itself.

Installing the Development version

Download

Download the distribution directory:

$ git clone git@github.com:StingraySoftware/HENDRICS

Or

$ git clone https://github.com/StingraySoftware/HENDRICS

To update the software, just run

$ git pull

from the source directory (usually, the command gives troubleshooting information if this doesn’t work the first time).

Installation

Install the dependencies above; then, enter the distribution directory and run

$ pip install .

this will check for the existing dependencies and install the files in a proper way. From that point on, executables will be somewhere in your PATH and python libraries will be available in python scripts with the usual

import hendrics