Main Page: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= Welcome to GNU Radio! =
== Introduction ==
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 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 is licensed under the GNU General Public License (GPL) version 3 or later. All of the code is copyright of the Free Software Foundation.
GNU Radio is licensed under the GNU General Public License (GPL) version 3 or later. All of the code is copyright of the Free Software Foundation.


== Content ==
= Getting started =


=== 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.


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.
The recommended way to get started with GNU Radio is to read the '''[[Guided Tutorials|Guided Tutorials]]'''.


* [[WhatIsGR|What is GNU Radio and why do I want it?]] - Read this if you really have no idea what this project is about.
* [[WhatIsGR|What is GNU Radio and why do I want it?]] - Read this if you really have no idea what this project is about.
Line 20: Line 16:
** [[Guided Tutorials|Guided Tutorials]]
** [[Guided Tutorials|Guided Tutorials]]
** [[TutorialsWritePythonApplications|How to write Python applications]] - This includes a guide on how to read and use the Doxygen-generated API docs.
** [[TutorialsWritePythonApplications|How to write Python applications]] - This includes a guide on how to read and use the Doxygen-generated API docs.
** [[Tutorials/Simulations|A quick guide on doing simulations with GNU Radio]]
** [[TutorialsSimulations|A quick guide on doing simulations with GNU Radio]]
** [[OutOfTreeModules|How to write an out-of-tree (OOT) module]]
<!-- ** [[OutOfTreeModules|How to write an out-of-tree (OOT) module]] -->
** [[OutOfTreeModulesConfig|Tutorial on how to configure OOT packages to find and link against GNU Radio]]
** [[OutOfTreeModulesConfig|Tutorial on how to configure OOT packages to find and link against GNU Radio]]
* [[FAQ|Frequently Asked Questions]] - Check this page before asking questions on the mailing list.
* [[FAQ|Frequently Asked Questions]] - Check this page before asking questions on the mailing list.


=== II. Documentation ===
= 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 [http://www.stack.nl/~dimitri/doxygen/ Doxygen] markup comments in the public header files. These are the basis for both manuals. The Python documentation uses [http://sphinx.pocoo.org/ Sphinx] to pull in both the Doxygen documentation as well as any formatted comments present in any Python files.
GNU Radio has two manuals: one for the C++ API and another for the Python API. The majority of the documentation comes from using [http://www.stack.nl/~dimitri/doxygen/ Doxygen] markup comments in the public header files. These are the basis for both manuals. The Python documentation uses [http://sphinx.pocoo.org/ Sphinx] to pull in both the Doxygen documentation as well as any formatted comments present in any Python files.
Line 34: Line 30:




Manual Pages of Interest (click to unfold)
Manual Pages of Interest:


* [http://gnuradio.org/doc/doxygen/build_guide.html Build Guide]
* [http://gnuradio.org/doc/doxygen/build_guide.html Build Guide]
Line 52: Line 48:
* [[GNURadioCompanion|The GNU Radio Companion]], a GUI IDE for developing GNU Radio applications.
* [[GNURadioCompanion|The GNU Radio Companion]], a GUI IDE for developing GNU Radio applications.


=== III. Community &amp; Communicating ===
= Community &amp; Communicating =


There's a nice community of people involved in GNU Radio. Here's some pointers on how to connect with us.
There's a nice community of people involved in GNU Radio. Here's some pointers on how to connect with us.
Line 65: Line 61:
* [[DevelopersCalls]] - The developers have monthly VoIP conferences which are open to join.
* [[DevelopersCalls]] - The developers have monthly VoIP conferences which are open to join.
* [[GNURadioConference|The GNU Radio Conference]]
* [[GNURadioConference|The GNU Radio Conference]]
** [http://gnuradio.org/grcon-2017/ GRCon2017]
** [http://gnuradio.org/grcon-2016/ GRCon2016]
** [http://gnuradio.org/grcon-2016/ GRCon2016]
** [http://www.trondeau.com/gnu-radio-conference-2015/ GRCon2015]
** [http://www.trondeau.com/gnu-radio-conference-2015/ GRCon2015]
Line 70: Line 67:
** [http://www.trondeau.com/gnu-radio-conference-2013/ GRCon2013]
** [http://www.trondeau.com/gnu-radio-conference-2013/ GRCon2013]
** [http://www.trondeau.com/gnu-radio-conference-2012/ GRCon2012]
** [http://www.trondeau.com/gnu-radio-conference-2012/ GRCon2012]
** [http://www.trondeau.com/gnu-radio-conference-2011g/ GRCon2011]
** [http://www.trondeau.com/gnu-radio-conference-2011/ GRCon2011]
* [[:Category:Hackfests|Hackfests]]
 
{{cot|title=List of hackfests}}
List of Hack Fests
** [[Hackfest1503|Hackfest 03/2015]] (Ettus Research)
* [[Hackfest1503|Hackfest 03/2015]] (Ettus Research)
** [[Hackfest1501|Hackfest 01/2015]] (TU Delft)
* [[Hackfest1501|Hackfest 01/2015]] (TU Delft)
** [[Hackfest1405|Hackfest 05/2014]] (First EU Hackfest)
* [[Hackfest1405|Hackfest 05/2014]] (First EU Hackfest)
** [[Hackfest1403-2|Hackfest 03/2014]]
* [[Hackfest1403-2|Hackfest 03/2014]]
** [[Hackfest1403|Hackfest 03/2014]] (After WSR '14)
* [[Hackfest1403|Hackfest 03/2014]] (After WSR '14)
** [[Hackfest1310|Hackfest 10/2013]] (At GRCon '13)
* [[Hackfest1310|Hackfest 10/2013]] (At GRCon '13)
** [[Hackfest1306|Hackfest 06/2013]]
* [[Hackfest1306|Hackfest 06/2013]]
** [[Hackfest1211|Hackfest 11/2012]]<br />
* [[Hackfest1211|Hackfest 11/2012]]
{{cob}}
 
* [https://calendar.google.com/calendar/embed?src=gnuradio.org_o5cbsdudkbk0f42ougcrcqgn00%40group.calendar.google.com&ctz=America/New_York GNU Radio Events Calendar]
[https://calendar.google.com/calendar/embed?src=gnuradio.org_o5cbsdudkbk0f42ougcrcqgn00%40group.calendar.google.com&ctz=America/New_York GNU Radio Events Calendar]
** [https://calendar.google.com/calendar/ical/gnuradio.org_o5cbsdudkbk0f42ougcrcqgn00%40group.calendar.google.com/public/basic.ics ICS Import Link]
* [https://calendar.google.com/calendar/ical/gnuradio.org_o5cbsdudkbk0f42ougcrcqgn00%40group.calendar.google.com/public/basic.ics ICS Import Link]


=== IV. Developing GNU Radio ===
= 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. Some of the [[Tutorials|tutorials]] are also relevant.
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. Some of the [[Tutorials|tutorials]] are also relevant.
Line 99: Line 96:
* YouTube feed from Ettus Research [http://www.youtube.com/user/ettusresearch/feed featuring demos and howtos] for using GNU Radio and USRPs.
* YouTube feed from Ettus Research [http://www.youtube.com/user/ettusresearch/feed featuring demos and howtos] for using GNU Radio and USRPs.
* [[Embedded|Embedded Development with GNURadio]]
* [[Embedded|Embedded Development with GNURadio]]
* [[GSoC|Summer of Code Programs]] Student Summer of Code Programs from Google (GSoC) and ESA (SOCIS)


=== V. Hardware ===
= 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, either natively or through additional out-of-tree modules.
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, either natively or through additional out-of-tree modules.
Line 106: Line 104:
For a list of supported devices, see our [[Hardware]] page.
For a list of supported devices, see our [[Hardware]] page.


=== VI. Further information and 3rd party extensions ===
= 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.
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.


* [http://cgran.org The Comprehensive GNU Radio Archive Network (CGRAN)]
* [http://cgran.org The Comprehensive GNU Radio Archive Network (CGRAN)]
* [https://github.com/search?q=gnuradio&ref=commandbar GNU Radio code on github.com]
* [[SuggestedReading|Suggested Reading]] - A list of non-GNU Radio-related literature, including good introductions to signal processing, radio engineering and software development.
* [[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]]
* [[OtherCode|GNU Radio code on other servers]]
Line 121: Line 118:
* [[SampleData|Pre-recorded sample data]] - If you don't have a USRP, find real recorded signals for offline analysis here.
* [[SampleData|Pre-recorded sample data]] - If you don't have a USRP, find real recorded signals for offline analysis here.


==== Related projects ====
== Related projects ==


* [http://www.openbts.org OpenBTS] - An Open Source GSM interface. This is a separate project, with its own mailing list.
* [http://www.openbts.org OpenBTS] - An Open Source GSM interface. This is a separate project, with its own mailing list.
* [http://gqrx.dk/ GQRX] - Very nice spectrum analysis tool, powered by GNU Radio
* [http://gqrx.dk/ GQRX] - Very nice spectrum analysis tool, powered by GNU Radio

Revision as of 18:10, 20 April 2017

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 is licensed under the GNU General Public License (GPL) version 3 or later. All of the code is copyright of the Free Software Foundation.

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.

The recommended way to get started with GNU Radio is to read the Guided Tutorials.

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 markup comments in the public header files. These are the basis for both manuals. The Python documentation uses Sphinx to pull in both the Doxygen documentation as well as any formatted comments present in any Python files.


Manual Pages of Interest:


Documentation on this wiki:

Community & Communicating

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

List of Hack Fests

GNU Radio Events Calendar

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. Some of the tutorials are also relevant.

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, either natively or through additional out-of-tree modules.

For a list of supported devices, see our Hardware page.

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.

Related projects

  • OpenBTS - An Open Source GSM interface. This is a separate project, with its own mailing list.
  • GQRX - Very nice spectrum analysis tool, powered by GNU Radio