sigpyproc

sigpyproc is a pulsar and FRB data analysis library for python. It provides an OOP approach to pulsar data handling through the use of objects representing different data types (e.g. SIGPROC filterbank, PSRFITS, time-series, fourier-series, etc.). As pulsar data processing is often time critical, speed is maintained using the excellent numba library.

Installation

The package requires Python 3.12 or newer.

pip install sigpyproc

Until 2.0.0 is on PyPI, install the release candidate from git:

pip install -U git+https://github.com/FRBs/sigpyproc3

See the installation page for a development checkout.

Older releases

2.0.0 is the stable API. The legacy branch and the last 0.x release, 0.5.5, keep the previous interface.

Usage

from sigpyproc import FilReader, PFITSReader, TimeSeries

fil = FilReader("tutorial.fil")
fits = PFITSReader("tutorial.fits")

ts = TimeSeries.from_tim("observation.tim")
hits = ts.search(nfolds=4, pmax=10.0)
hits.cluster(snr_min=8.0).to_csv("cands.csv")

Check out the filterbank quickstart, the search tutorial, and the API docs for more.

Contributing

Check out the developer documentation for more info about getting started.