Imported Upstream version 3.2.2
[debian/gnuradio] / gr-trellis / src / examples / README
1 Here we have several test programs for use with the gr-trellis implementation.
2 Documentation can be found in 
3 http://gnuradio.utah.edu/svn/gnuradio/trunk/gr-trellis/doc/gr-trellis.html
4
5 fsm_utils.py contains several useful functions.
6
7 fsm_files is a directory with some FSM definitions
8
9 If you just want to see what these programs do, run each of the following:
10
11 ./test_tcm.py  fsm_files/awgn1o2_4.fsm 6.0 1000
12 ./test_tcm1.py fsm_files/awgn1o2_4.fsm 6.0 1000
13 ./test_tcm2.py 6.0 1000
14 ./test_tcm_combined.py fsm_files/awgn1o2_4.fsm 6.0 1000
15 ./test_tcm_parallel.py fsm_files/awgn1o2_4.fsm 6.0 1000
16
17 ./test_sccc_hard.py  fsm_files/awgn1o2_4.fsm fsm_files/awgn2o3_4_msb.fsm 10.0 100
18 ./test_sccc_soft.py  fsm_files/awgn1o2_4.fsm fsm_files/awgn2o3_4_msb.fsm  8.0 100
19 ./test_sccc_turbo.py fsm_files/awgn1o2_4.fsm fsm_files/awgn2o3_4_msb.fsm  5.0 100
20
21 ./test_viterbi_equalization.py  12.0 100
22 ./test_viterbi_equalization1.py 12.0 100
23 ./test_turbo_equalization1.py fsm_files/awgn1o2_4.fsm 8.0 100
24 ./test_turbo_equalization2.py fsm_files/awgn1o2_4.fsm 8.0 100
25
26
27 In your terminal you will see something like this:
28
29
30 $ ./test_tcm.py fsm_files/awgn1o2_4.fsm 6.0 1000
31 100 98 9.80e-01 102400 9 8.79e-05
32 200 198 9.90e-01 204800 20 9.77e-05
33 300 298 9.93e-01 307200 40 1.30e-04
34 400 398 9.95e-01 409600 1074 2.62e-03
35 500 498 9.96e-01 512000 1081 2.11e-03
36 600 598 9.97e-01 614400 1090 1.77e-03
37 700 698 9.97e-01 716800 1097 1.53e-03
38 800 798 9.98e-01 819200 1107 1.35e-03
39 900 898 9.98e-01 921600 1120 1.22e-03
40 1000 998 9.98e-01 1024000 1129 1.10e-03
41 1000 998 9.98e-01 1024000 1129 1.10e-03
42
43 which gives you information about the:
44 number of transmitted packets
45 number of packets in error
46 estimated packet error rate
47 number of transmitted shorts (or symbols, or bits, depending on the specific program)
48 number of shorts (or symbols, or bits) in error
49 estimated short (or symbol, or bit) error rate 
50
51 for instance, the final number 1.10e-03 is the error rate estimate by sending 1000 
52 packets of 1024 shorts each, using an 1/2 4-state convolutional code 
53 and QPSK modulation through an AWGN with Es/N0 = 6.0 dB