h1. Welcome to GNU Radio!

h2. Introduction

{{>toc}}

GNU Radio is a free & open-source software development toolkit that provides signal processing blocks to implement software radios.  It can be used with readily-available low-cost external RF hardware to create software-defined radios, or without hardware in a simulation-like environment.  It is widely used in hobbyist, academic and commercial environments to support both wireless communications research and real-world radio systems.

GNU Radio applications are primarily written using the Python programming language, while the supplied performance-critical signal processing path is implemented in C++ using processor floating-point extensions, where available.  Thus, the developer is able to implement real-time, high-throughput radio systems in a simple-to-use, rapid-application-development environment.

While not primarily a simulation tool, GNU Radio does support development of signal processing algorithms using pre-recorded or generated data, avoiding the need for actual RF hardware.

GNU Radio is licensed under the GNU General Public License (GPL) version 3. All of the code is copyright of the Free Software Foundation.

h2. GNU Radio Conference, 2012

We are actively working on putting together the second annual GNU Radio conference to be held in Atlanta, September 24 - 27. Please visit the main conference website for details, updates, and to submit ideas for presentations:

http://www.trondeau.com/gnu-radio-conference-2012/

h2. Content

h3. I. Getting started

If you've never touched GNU Radio before, these pages will get you started with a running installation of GNU Radio and will show you how to take your first steps with this software radio tool.

* [[WhatIsGR|What is GNU Radio and why do I want it?]] - Read this if you really have no idea what this project is about.

* [[InstallingGR|Installing GNU Radio]] - This will explain all the steps to get a working installation of GNU Radio.

** [[Download]] - Jump straight to the source.

** [[BuildGuide|Build Guide]] - For experts: how to build GNU Radio manually from source code.

* [[FAQ|Frequently Asked Questions]] - Read this. Seriously, really read this before asking questions.

h3. II. Documentation

GNU Radio has two manuals: one for the C++ API and another for the Python API. The majority of the documentation comes from using "Doxygen":http://www.stack.nl/~dimitri/doxygen/ markup comments in the public header files. These are the basis for both manuals. The Python documentation uses "Sphinx":http://sphinx.pocoo.org/ to pull in both the Doxygen documentation as well as any formatted comments present in any Python files.

* "C++ Manual":http://gnuradio.org/doc/doxygen/index.html - This includes a complete list of available blocks.

** [[old-docs|Documentation for older releases]]

* "Python Manual":http://gnuradio.org/doc/sphinx/index.html - This includes a complete list of available blocks.

** [[old-sphinx|Documentation for older releases]]

h3. III. Community & Communicating

There's a nice community of people involved in GNU Radio. Here's some pointers on how to connect with us.

* [[ReportingErrors|Asking Questions and Reporting Errors]] - We're helpful people, but *we expect you to try to help yourself first.*

* [[MailingLists|Mailing lists]] - Where most of the communication happens, but please read the previous article first.

* [[IRC|IRC]] - For a more real-time interaction, come join our chat room @#gnuradio@ on Freenode.

* [[MoreCommunity|More GNU Radio on the web and in social media]]

* [[DevelopersCalls]] - The developers have monthly VoIP conferences which are open to join.

* [[GNURadioConference|The GNU Radio Conference]]

*** "GRCon2012 Call for presentations":http://www.trondeau.com/grc2012-call-for-presentations/

*** "GNU Radio Conference 2011":http://gnuradio.trondeau.com/gnu-radio-conference-2011/, a real-life developers and enthusiast meeting

h3. IV. Using GNU Radio

Once GNU Radio is installed and running, check these pages to find out how to actually use GNU Radio. These articles refer to anything that does not involve writing C++ or signal processing code.

* [[HowToUse|How do I use GNU Radio?]] - A short introduction to the possibilities you have as a GNU Radio user.

* [[GNURadioCompanion|The GNU Radio Companion]], a GUI IDE for developing GNU Radio applications.

* [[HowToUse#Using-the-included-tools-and-utility-programs|Utilities and tools that come with GNU Radio]]

* [[Tutorials|Tutorials]]

** [[TutorialsWritePythonApplications| How to write Python applications]] - This includes a guide on how to read and use the Doxygen-generated API docs.

* [[Simulations|A quick guide on doing simulations with GNU Radio]]

h3. V. Developing GNU Radio

Using GNU Radio is nice, but the real fun comes with developing new components for GNU Radio or actually changing the core itself. If you want to write some code, read these articles first.

* [[Development|Development Information for Contributors]]

* [[Coding_guide_impl|Coding and style guidelines for GNU Radio]]

* [[BlocksCodingGuide|Block structure guide]]

* [[OutOfTreeModules|How to Write a GNU Radio Signal Processing Block]]

* [[Octave|How to use Octave or Matlab with GNU Radio]]

* [[ChangeSets|API and Code Version Changes]]

* [[DevelopingWithGit|How to use git to track your own GNU Radio code]]

* YouTube feed from Ettus Research "featuring demos and howtos":http://www.youtube.com/user/ettusresearch/feed for using GNU Radio and USRPs.

h3. VI. Hardware

Hardware is strictly *not* part of GNU Radio, which is purely a software library. However, developing radio and signal processing code is even more fun when using hardware to actually transmit and receive, and GNU Radio supports several radio front-ends.

The most commonly used equipment are the USRP devices by "Ettus Research, LLC.":http://www.ettus.com.

* [[Hardware]] - A quick guide for getting all kinds of hardware running with GNU Radio.

* "UHD - Hardware driver for all Ettus Research products":http://code.ettus.com/redmine/ettus/projects/uhd/wiki

* The [[USRP|USRP1]]

* The [[USRP2]]

* [[List_of_USRP_daughterboards|List of USRP daughterboards]]

For other Ettus products check out their "website":http://www.ettus.com!

h3. VII. Further information and 3rd party extensions

There's more stuff to be found for GNU Radio on the web. Check these pages to find tutorials, code and other information on GNU Radio.

* "The Comprehensive GNU Radio Archive Network":https://cgran.org - 3rd party GNU Radio applications and extensions.

* [[SuggestedReading|Suggested Reading]] - A list of non-GNU Radio-related literature, including good introductions to signal processing, radio engineering and software development.

* [[OtherCode|GNU Radio code on other servers]]

* [[ExternalDocumentation|Documentation and Videos for GNU Radio on other servers]]

* [[OurUsers|Real world users]]

* [[AcademicPapers|Academic papers involving GNU Radio]]

* [[Support|Commercial support and training]]

* [[Presentations]]

* "OpenBTS":http://wush.net/trac/rangepublic - An Open Source GSM interface. This is a separate project, with its own mailing list.

* [[SampleData|Pre-recorded sample data]] - If you don't have a USRP, find real recorded signals for offline analysis here.

h2. Other Languages

* [[gnuradio_zh|SimpleChinese(中文)]]

* [[EnEspanol|Spanish]]