Merge branch 'qtmake' of git@gnuradio.org:trondeau into master
[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. A
19 configuration file 'usrp_rx_hrpt.cfg' in the current working directory will
20 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 word but with more bit
25 errors.  No other decimation rates will work.
26
27 usrp_rx_hrpt2.py
28 ----------------
29
30 This GUI script uses fewer graphical displays to reduce CPU consumption on
31 slower machines, but otherwise operates identically to userp_rx_hrpt.py.
32
33 usrp_rx_hrpt_nogui.py
34 ---------------------
35
36 This non-GUI script operates without a display and requires that all parameters
37 be set in the configuration file prior to running.  It has no command-line
38 parameters, and works identically to the GUI scripts.
39
40 demod_hrpt_file.py
41 ------------------
42
43 This non-GUI script will operate on a file generated with
44 usrp_rx_cfile.py and output frames in the same format as above.  It does
45 *not* use the configuration file above; instead you must pass parameters to
46 it on the command line.  To exit the program, press Enter.
47
48 Usage: demod_hrpt_file.py: [options]
49
50 Options:
51   -h, --help            show this help message and exit
52   -d DECIM, --decim=DECIM
53                         Set Decimation [default=16]
54   -p PLL_ALPHA, --pll-alpha=PLL_ALPHA
55                         Set pll_alpha [default=50m]
56   -s SYNC_ALPHA, --sync-alpha=SYNC_ALPHA
57                         Set sync_alpha [default=50m]
58   -F FILENAME, --filename=FILENAME
59                         Set Filename [default=usrp.dat]
60   -o OUTPUT, --output=OUTPUT
61                         Set Output [default=frames.dat]
62
63
64 LRIT Operation
65 --------------
66
67 The work-in-progress LRIT GRC script is not currently in a usable state.