CygnusRFI/README.md

78 lines
1.5 KiB
Markdown

# CygnusRFI: An open-source RFI analysis tool for Ground Stations & Radio Telescopes
This is a port of CygnusRFI from Python 2 to Python 3.
![RF Plot](img/example-rfi_plot.png)
# Setup
Install dependencies.
```
sudo apt install --no-install-recommends python3-pip python3-virtualenv \
gnuradio gr-osmosdr
```
Install CygnusRFI fork.
```
git clone https://spacecruft.org/spacecruft/CygnusRFI.git
cd CygnusRFI/
virtualenv -p python3 env
source env/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
```
# Use
Example:
```
export PYTHONPATH=/usr/lib/python3/dist-packages:/usr/lib/python3/site-packages:$PYTHONPATH
python CygnusRFI.py -b 2400000 -c 2048 -t 0.5 -d 5 -f 400000000 -F 430000000
```
# Help
Help output.
```
$ python CygnusRFI.py -h
usage: CygnusRFI.py [-h] -b BANDWIDTH [-c CHANNELS] [-t T_INT] -d DURATION -f FMIN -F FMAX
options:
-h, --help show this help message and exit
-b BANDWIDTH, --bandwidth BANDWIDTH
-c CHANNELS, --channels CHANNELS
-t T_INT, --t_int T_INT
-d DURATION, --duration DURATION
-f FMIN, --fmin FMIN
-F FMAX, --fmax FMAX
```
# Upstream
See `README-upstream.md`
https://github.com/0xCoto/CygnusRFI
**CygnusRFI** was created by **[Apostolos Spanakis-Misirlis](https://www.github.com/0xCoto/)**.
**Contact:** [0xcoto@protonmail.com](mailto:0xcoto@protonmail.com)
# Status
It appears to be working, but has been minimally tested.
# Copyright
Upstream sources under their respective copyrights.
License, same as upstream: GPLv3.
*Copyright © 2023, Jeff Moe.*