Installation

Note

sigpyproc requires Python 3.8 and later.

Using pip

The recommended method of installing sigpyproc is with pip:

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

Some of the required dependencies are:

• numpy

• astropy

• numba

• bottleneck

• h5py

• attrs

• rich

• click

• iqrm

From Source

The source code for sigpyproc can be downloaded and installed from GitHub by running

git clone https://github.com/FRBs/sigpyproc3.git
cd sigpyproc3
python -m pip install -e .

Testing

To run the unit tests with pytest, first install the testing dependencies using pip:

python -m pip install -e ".[tests]"

and then execute:

python -m pytest -v tests

Normally, all of the tests should pass.