CygnusRFI/README.md

54 lines
989 B
Markdown
Raw Normal View History

2020-02-21 18:21:27 -07:00
# CygnusRFI: An open-source RFI analysis tool for Ground Stations & Radio Telescopes
2023-01-17 08:39:46 -07:00
This is an attempt at a port from Python 2 to Python 3.
2020-02-21 18:09:31 -07:00
2023-01-17 08:44:38 -07:00
# Setup
2023-01-17 09:22:08 -07:00
Install dependencies.
```
sudo apt install --no-install-recommends python3-pip python3-virtualenv gnuradio
```
Install CygnusRFI fork.
2023-01-17 08:44:38 -07:00
```
git clone https://spacecruft.org/spacecruft/CygnusRFI.git
cd CygnusRFI/
virtualenv -p python3 env
source env/bin/activate
pip install --upgrade pip
2023-01-17 09:12:57 -07:00
pip install -r requirements.txt
2023-01-17 08:44:38 -07:00
```
# Use
Thusly
```
python CygnusRFI.py
```
# 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
```
2020-02-21 18:09:31 -07:00
2023-01-17 08:39:46 -07:00
# Upstream
See `README-upstream.md`
2020-02-21 18:09:31 -07:00
2023-01-17 08:39:46 -07:00
https://github.com/0xCoto/CygnusRFI
2020-02-21 18:09:31 -07:00