Houston, we have a trunk.
[debian/gnuradio] / gnuradio-examples / README
1 #
2 # Copyright 2004 Free Software Foundation, Inc.
3
4 # This file is part of GNU Radio
5
6 # GNU Radio is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2, or (at your option)
9 # any later version.
10
11 # GNU Radio is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with GNU Radio; see the file COPYING.  If not, write to
18 # the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 # Boston, MA 02111-1307, USA.
20
21
22 Welcome!
23
24 This package is a collection of examples for the GNU Radio 2.x toolkit.
25
26 They assume that at a minimum, you've got the gnuradio-core
27 package installed.  In addition, depending on what i/o devices you
28 have, you may want to consider installing:
29
30   gr-usrp               : support for Universal Software Radio Peripheral (Rev 1)
31   gr-audio-oss          : sound card support using OSS
32   gr-audio-alsa         : sound card support using ALSA
33   gr-audio-osx          : sound card support for OS/X
34   gr-mc4020             : Measurement Computing PCI-DAS 4020/12 A/D card
35
36
37 You'll need to set your PYTHONPATH environment variable so that the
38 GNU Radio toolkit and optional packages can be found by python.
39
40 PYTHONPATH should include the path of the local site-packages
41 directory.  It has the general form:
42
43   ${prefix}/lib/python${pythonversion}/site-packages
44
45 If the above packages were installed using the default prefix
46 (/usr/local) and you're using python 2.3, this should work:
47
48   $ export PYTHONPATH=/usr/local/lib/python2.3/site-packages
49
50 You may want to add this to your ~/.bash_profile or similar file.
51
52
53 Once PYTHONPATH is set, you should be able to run any of the examples
54 for which you have the required i/o devices.
55
56 To ensure that your setup is sane, try this:
57
58   $ python
59   >>> from gnuradio import gr
60
61 If this works, your PYTHONPATH is set correctly.
62
63
64 Have fun!
65
66 The GNU Radio team
67
68