User talk:Duggabe: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
== "Recycle Bin", content we no longer link to that we may eventually just delete ==
== Skeleton for Block Docs ==


* [[Guided_Tutorial_GNU_Radio_in_Python|Programming GNU Radio in Python]]
Statement of purpose / function
* [[TutorialsRemoteGUI|Remote GRC Operations]] - needs updating!
* [[UsingVim|Using VIM plugins for GNU Radio development]]
* [[TutorialsQTGUI|QTGUI Tutorial]] - A tutorial on how to develop Python GNU Radio applications.
* [[Guided_Tutorial_Extras_Sample_Rates#E2.3._A_Note_on_Resampling]] - covered by Understanding sample rate
* [[TutorialsCoreConcepts|Core concepts of GNU Radio applications]] - content used in other pages
* [[TutorialsWritePythonApplications|WritePythonApplications]] - content used in other pages
* [[OutOfTreeModulesConfig|Tutorial on how to configure OOT packages to find and link against GNU Radio]] - for 3.7; also, most of the content is covered in Writing blocks in C++
* [[TutorialPythonFunctions|Writing a Python Function for GRC]] - for 3.7; content used in other pages; it doesn't work as written!
* [[TutorialsDebugging|How to debug your applications]] - not well written; would need major rework and update


== Status of gr-tutorial use with Tutorials ==
== Parameters ==
<b>(''R''):</b> <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


Of the seven original tutorials, the only one which references the files in gr-tutorial is Guided_Tutorial_PSK_Demodulation. There are 12 flowgraphs for it in https://github.com/gnuradio/gr-tutorial/tree/master/examples/tutorial7  Since there are pictures of all the flowgraphs and outputs, we could just have the one final flowgraph in-tree, and remove all the links to gr-tutorial.
; Sample Rate
: The sample rate for the block (default: samp_rate).


The code for 'my_qpsk_demod' is not used, and none of the other files in gr-tutorial are used either.
etc.


My recommendations:
== Messages ==


# remove the links to the flowgraphs in https://wiki.gnuradio.org/index.php/Guided_Tutorial_PSK_Demodulation, revising the wording as needed.<br>
=== Inputs ===
# remove references to gnuradio/gr-tutorial in https://wiki.gnuradio.org/index.php/Guided_Tutorial_GRC<br>
# mark https://wiki.gnuradio.org/index.php/Installing_the_Tutorials_Modules as deprecated.<br>
# change https://github.com/gnuradio/gr-tutorial/blob/master/README.md to say that it is deprecated; OR delete gnuradio/gr-tutorial entirely.<br>


== a dummy section ==
=== Outputs ===


== a dummy section ==
== Example Flowgraph ==
 
== Example Output ==
 
== Source Files ==
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]

Revision as of 12:10, 7 June 2021

Skeleton for Block Docs

Statement of purpose / function

Parameters

(R): Run-time adjustable

Sample Rate
The sample rate for the block (default: samp_rate).

etc.

Messages

Inputs

Outputs

Example Flowgraph

Example Output

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO
Retrieved from "https://wiki.gnuradio.org/index.php?title=User_talk:Duggabe&oldid=8665"