Tutorials: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(replace contents with new outline and format)
Line 1: Line 1:
= Guided Tutorials =
= Beginner User Level =
These tutorials are designed to guide new GNU Radio users to a better understanding of the project.
* [[Guided_Tutorial_Introduction|'''A brief introduction to GNU Radio, SDR, and DSP''']]
* [[Guided_Tutorial_GRC|'''Intro to GR usage: GRC and flowgraphs''']]
* [[Guided_Tutorial_Hardware_Considerations|'''Using GNU Radio with Hardware''']]
* [[Sample_Rate_Tutorial|'''Understanding sample rate''']]
* [[Guided_Tutorial_Programming_Topics|'''Brief intro to PMTs, Stream Tags, and Messaging Passing''']]
* [[Guided_Tutorial_PSK_Demodulation|'''Example Usage of GNU Radio: PSK Demodulation''']]


These tutorials are designed to guide new GNU Radio users to a better understanding of the project: how to work with it, interact with the library, and build your own components and blocks. By the end, you should be comfortable with many of the capabilities of GNU Radio and have some sense for the available tools, functions, and tricks to building your own signal processing project.
= Intermediate User Level =
* [[Flowgraph_Python_Code|'''Understanding a flowgraph's python code''']]
* [[Embedded_Python_Block|'''Writing your own block''' (using Embedded Python Block)]]
* '''Writing the XML file for a block''' (for 3.7) (TBD)
* [[YAML_GRC|'''Writing the YAML file for a block''' (new in 3.8)]]
* [[OutOfTreeModules|'''Out of Tree modules''']]
* [[Guided_Tutorial_GNU_Radio_in_C++|'''Writing blocks in C++''' (for 3.7)]]
*  '''Writing blocks in C++''' (new in 3.8) (TBD)


# [[InstallingGR|Installing GNU Radio]]
= Expert User Level =
# [[Guided_Tutorial_Introduction|Introduction]]
*  '''Writing flowgraphs in C++''' (new in 3.8) (TBD)
# [[Guided_Tutorial_GRC|Working with GRC]]
* [[VOLK_Guide|'''Volk- what it does, why it rocks, how to write new kernels''']]
# [[Guided_Tutorial_GNU_Radio_in_Python|Programming GNU Radio in Python]]
* [[ALSAPulseAudio|'''Working with ALSA and Pulse Audio''']]
# [[Guided_Tutorial_GNU_Radio_in_C++|Programming GNU Radio in C++]]
* [[TutorialsSimulations|'''Simulations''']]
# [[Guided_Tutorial_Programming_Topics|Programming Topics]]
* [[TutorialsTaggedStreams|'''Tagged streams for variable-length PDUs''']]
# [[Guided_Tutorial_Hardware_Considerations|Using GNU Radio with Hardware]]
* [[Basic OFDM Tutorial|'''Basics of OFDM''']]
# [[Guided_Tutorial_PSK_Demodulation|PSK Symbol Demodulation]]
# [[Guided Tutorial Extras Sample Rates| Guided Tutorial Extras: Sample Rates]]


= Beginner-level tutorials =
= Developer Level =
 
* [[UsingVSCode|'''Source level debugging C++ OOT modules with Visual Studio Code''']]
Note that even as a GNU Radio beginner, you'll be delving into the realm of software defined radio, which is a complex field.
* [[UsingEclipse|'''Building and source level debugging C++ OOT modules with Eclipse''']]
 
* [[DevelopingWithGit|'''Git and GNU Radio''']]
* [[TutorialsCoreConcepts|Core concepts of GNU Radio applications]] - A must-read for everyone
* [[Octave|'''How to use Octave or Matlab with GNU Radio''']]
* [[TutorialsWritePythonApplications|WritePythonApplications]] - A tutorial on how to develop Python GNU Radio applications. Some DSP and programming background required.
* [[TutorialsQTGUI|QTGUI Tutorial]] - A tutorial on how to develop Python GNU Radio applications. Some DSP and programming background required.
* [http://www.trondeau.com/gr-tutorial/ Tom Rondeau's gr-tutorial] - Some tutorials from the boss himself.
* [[TutorialsSimulations|Simulations]] - A tutorial on how to use GNU Radio without hardware to verify performance and simulate RF conditions.
* [[Basic OFDM Tutorial]] - Basics of OFDM and how to do rx and tx in GNU Radio
 
= Tutorials on developing with and for GNU Radio =
 
== Writing GNU Radio code ==
 
* [[OutOfTreeModules|Developing out-of-tree modules and writing blocks]] -- this is slightly deprecated by now. Please read the "Guided Tutorials" from chapter 1 to "Programming GNU Radio in Python".
** [[OutOfTreeModulesConfig|Tutorial on how to configure OOT packages to find and link against GNU Radio]]
* [[TutorialsTaggedStreams|Tagged streams for variable-length PDUs]]
* [[TutorialPythonFunctions|Writing a Python Function for GRC]]
 
== Advanced Development ==
 
* [[TutorialsDebugging|How to debug your applications]]
* [[Octave|How to use Octave or Matlab with GNU Radio]]
* The GNU Radio Scheduler http://www.trondeau.com/blog/2013/9/15/explaining-the-gnu-radio-scheduler.html
* [http://www.brainshark.com/SPS/vu?pi=zH8zQcV8dzAXPbz0 VOLK Introduction]
* [[TutorialsRemoteGUI|Remote GRC Operations]]
* [[ALSAPulseAudio|Working with ALSA and Pulse Audio (Audio sink/source under Linux)]]
 
== Development tools ==
 
* [[DevelopingWithGit|Git and GNU Radio]] - A starter on how to use Git for GNU Radio development
* [[UsingVim|Using VIM for editing GNU Radio modules]]
* [[UsingCB|Using Code::Blocks for editing GNU Radio modules]]
* [[UsingEclipse|Building and source level debugging C++ OOT modules with eclipse]]
* [[UsingVSCode|Source level debugging C++ OOT modules with Visual Studio Code]]
 
 
The 3rd-party documentation lives on a separate page which can be found [[ExternalDocumentation|here]].

Revision as of 03:31, 19 January 2020