https://github.com/FRBs/sigpyproc3

Python3 version of Ewan Barr's sigpyproc library
https://github.com/FRBs/sigpyproc3

fast-radio-bursts filterbank pulsars radio-astronomy

Last synced: 2 months ago
JSON representation

Python3 version of Ewan Barr's sigpyproc library

• Host: GitHub
• URL: https://github.com/FRBs/sigpyproc3
• Owner: FRBs
• License: mit
• Created: 2020-04-16T17:23:05.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-16T13:07:01.000Z (3 months ago)
• Last Synced: 2025-03-16T13:36:28.998Z (3 months ago)
• Topics: fast-radio-bursts, filterbank, pulsars, radio-astronomy
• Language: Python
• Homepage: https://sigpyproc3.readthedocs.io
• Size: 13.3 MB
• Stars: 15
• Watchers: 2
• Forks: 11
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst
  • License: LICENSE

Awesome Lists containing this project

• frbsoft - GitHub - 30% open · ⏱️ 02.04.2025): (Data Read and Write Packages)

README

        
# sigpyproc

[![GitHub CI](https://github.com/FRBs/sigpyproc3/workflows/GitHub%20CI/badge.svg)](https://github.com/FRBs/sigpyproc3/actions)

[![Docs](https://readthedocs.org/projects/sigpyproc3/badge/?version=latest)](https://sigpyproc3.readthedocs.io/en/latest/?badge=latest)

[![codecov](https://codecov.io/gh/FRBs/sigpyproc3/branch/main/graph/badge.svg)](https://codecov.io/gh/FRBs/sigpyproc3)

[![License](https://img.shields.io/github/license/FRBs/sigpyproc3)](https://github.com/FRBs/sigpyproc3/blob/main/LICENSE)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/)

`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](http://sigproc.sourceforge.net),

[PSRFITS](https://www.atnf.csiro.au/research/pulsar/psrfits_definition/Psrfits.html), time-series, fourier-series, etc.).

As pulsar data processing is often time critical, speed is maintained using

the excellent [numba](https://numba.pydata.org) library.

## Installation

The quickest way to install the package is to use [pip](https://pip.pypa.io):

```bash

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

```

Note that you will need Python (>=3.11) installed to use `sigpyproc`.

Also check out the [installation documentation page](https://sigpyproc3.readthedocs.io/en/latest/install.html) for more options.

## Legacy Version

`sigpyproc` is currently undergoing major developements which will modify the existing API in order to be a modern python

replacemet for [SIGPROC](http://sigproc.sourceforge.net). To use the older API, you can install the ``legacy``

branch of this repo, or install the last released version 0.5.5.

## Usage

```python

from sigpyproc.readers import FilReader, PFITSReader

fil = FilReader("tutorial.fil")

fits = PFITSReader("tutorial.fits")

```

Check out the tutorials and API docs on [the docs page](https://sigpyproc3.readthedocs.io) for example usage and more info.

## Contributing

Check out [the developer documentation](https://sigpyproc3.readthedocs.io/en/latest/dev.html) for more info about getting started.