micro howto draft
parent
5f7dfcbceb
commit
ab3c4d1793
37
README.md
37
README.md
|
@ -1,6 +1,43 @@
|
|||
# CygnusRFI: An open-source RFI analysis tool for Ground Stations & Radio Telescopes
|
||||
This is an attempt at a port from Python 2 to Python 3.
|
||||
|
||||
# Setup
|
||||
Thusly
|
||||
|
||||
```
|
||||
git clone https://spacecruft.org/spacecruft/CygnusRFI.git
|
||||
cd CygnusRFI/
|
||||
virtualenv -p python3 env
|
||||
source env/bin/activate
|
||||
pip install --upgrade pip
|
||||
pip install pillow
|
||||
```
|
||||
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
# Upstream
|
||||
See `README-upstream.md`
|
||||
|
|
Loading…
Reference in New Issue