make maintainer-clean removes these, and we want a clean orig.tar.gz
[debian/gnuradio] / gr-noaa / README
1 This component implements an NOAA POES HRPT receiver.  After installation,
2 the scripts described below will be install in the users PATH.
3
4 As the scripts are generated using GRC, GRC must be installed at runtime
5 in order for them to operate.
6
7
8 HRPT OPERATION
9
10 usrp_rx_hrpt.py
11 ---------------
12
13 This GUI script will receive HRPT RF, demodulate, synchronize, and deframe
14 HRPT minor frames into a file.  The file stores a series of 11090 word,
15 16-bits per word corresponding to the HRPT minor frame format (only the
16 lower 10-bits per word are significant.)
17
18 The script file by default uses USRP side A, 1698 MHz, at decimation 16. The
19 gnuradio configuration file ~/.gnuradio/config.conf, section 'usrp_rx_hrpt.cfg',
20 will allow changing this, as well as implementing persistent storage of GUI
21 entered parameters from invocation to invocation.
22
23 The present HRPT demodulator is only tested at decimation 16.  The only other
24 valid decimation rates are 24 and 32, which may work but with more bit
25 errors.  No other decimation rates will work.
26
27
28 file_rx_hrpt.py
29 ---------------
30
31 This GUI script operates like usrp_rx_hrpt.py, but reads from a pre-captured
32 data file supplied by -F on the command line.
33
34
35 usrp_rx_hrpt_nogui.py
36 ---------------------
37
38 This non-GUI script operates without a display and requires that all parameters
39 be set in the configuration file prior to running.  It has no command-line
40 parameters, and works identically to the GUI scripts.
41
42
43 hrpt_demod_file.py
44 ------------------
45
46 This non-GUI script will operate on a file generated with
47 usrp_rx_cfile.py and output frames in the same format as above.  It does
48 *not* use the configuration file above; instead you must pass parameters to
49 it on the command line.  To exit the program, press Enter.
50
51 Usage: demod_hrpt_file.py: [options]
52
53 Options:
54   -h, --help            show this help message and exit
55   -d DECIM, --decim=DECIM
56                         Set Decimation [default=16]
57   -p PLL_ALPHA, --pll-alpha=PLL_ALPHA
58                         Set pll_alpha [default=50m]
59   -s CLOCK_ALPHA, --clock-alpha=CLOCK_ALPHA
60                         Set clock_alpha [default=50m]
61   -F INPUT_FILENAME, --input-filename=INPUT_FILENAME
62                         Set Filename [default=usrp.dat]
63   -o OUTPUT_FILENAME, --output-filename=OUTPUT_FILENAME
64                         Set Output [default=frames.dat]
65
66
67 LRIT Operation
68 --------------
69
70 The work-in-progress LRIT GRC script is not currently in a usable state.