[Commit-gnuradio] r8065 - in grc/branches/grc_reloaded: . notes src/grc_gnuradio src/grc_gnuradio/blocks/conversions src/grc_gnuradio/data

[jblum]

Author: jblum
Date: 2008-03-20 21:54:55 -0600 (Thu, 20 Mar 2008)
New Revision: 8065

Added:
   
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_interleaved_short.xml
   
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_interleaved_short_to_complex.xml
Removed:
   
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_ishort.xml
   
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_ishort_to_complex.xml
Modified:
   grc/branches/grc_reloaded/Makefile
   grc/branches/grc_reloaded/notes/todo.txt
   grc/branches/grc_reloaded/readme.txt
   grc/branches/grc_reloaded/src/grc_gnuradio/Block.py
   grc/branches/grc_reloaded/src/grc_gnuradio/data/block_tree.xml
Log:
makefile for docs install

Modified: grc/branches/grc_reloaded/Makefile
===================================================================
--- grc/branches/grc_reloaded/Makefile  2008-03-20 22:46:12 UTC (rev 8064)
+++ grc/branches/grc_reloaded/Makefile  2008-03-21 03:54:55 UTC (rev 8065)
@@ -19,8 +19,15 @@
 # Boston, MA 02110-1301, USA.
 # 
 
+DOCS_URL = http://www.ece.jhu.edu/~jblum/downloads/grc_gnuradio_docs.tar.gz
+DOCS_DEST = /usr/local/share/doc/
+
 all: 
-       @echo Options: build, install, clean
+       @echo Options: build, install, docs_install, clean
+       
+docs_install:
+       mkdir -p $(DOCS_DEST)
+       wget $(DOCS_URL) -O - | tar -xzv -C $(DOCS_DEST)
 
 build: clean
        python setup.py build
@@ -29,6 +36,5 @@
        python setup.py install
 
 clean:
-       if [ -d build ]; then rm -rf build; fi  
+       if [ -d build ]; then rm -rf build; fi
 
-

Modified: grc/branches/grc_reloaded/notes/todo.txt
===================================================================
--- grc/branches/grc_reloaded/notes/todo.txt    2008-03-20 22:46:12 UTC (rev 
8064)
+++ grc/branches/grc_reloaded/notes/todo.txt    2008-03-21 03:54:55 UTC (rev 
8065)
@@ -7,11 +7,15 @@
 -cpm (blks2)
 -filterbank (blks2)
 -usrp quad souce, set z == 1 to ignore Q inputs 
+-lfsr_32k_source_s
+-check_lfsr_32k_s?
+-glfsr_source_x
 
 ############   Known Problems: ####################
 -packet threads block on close
 -usrp transmit dies in lock/unlock
 -audio dies lock/unlock
+-numbersink needs patch to set peak hold
 
 ############   Features to Add:        ####################
 -startup tips
@@ -22,6 +26,7 @@
 -const sink constructor needs marker option
 -clean up const sink display
 -clean up scope sink display
+-grc open multiple file at once
 
 ############   wxPython Features:      ####################
 -dump wx running graph to png?

Modified: grc/branches/grc_reloaded/readme.txt
===================================================================
--- grc/branches/grc_reloaded/readme.txt        2008-03-20 22:46:12 UTC (rev 
8064)
+++ grc/branches/grc_reloaded/readme.txt        2008-03-21 03:54:55 UTC (rev 
8065)
@@ -12,3 +12,14 @@
 If you have questions, problems, suggestions, or want to contribute,
 please email me at jblum at jhu dot edu
 
+   ---   Quickstart   ---   
+
+Install grc: 
+       "sudo make install"
+       
+Install the grc/gnuradio docs: 
+       "sudo make docs_install"
+       
+Execute grc: 
+       open a terminal and type "grc"
+

Modified: grc/branches/grc_reloaded/src/grc_gnuradio/Block.py
===================================================================
--- grc/branches/grc_reloaded/src/grc_gnuradio/Block.py 2008-03-20 22:46:12 UTC 
(rev 8064)
+++ grc/branches/grc_reloaded/src/grc_gnuradio/Block.py 2008-03-21 03:54:55 UTC 
(rev 8065)
@@ -36,18 +36,29 @@
        if len(doc.childNodes) == 0: return str(doc.nodeValue)
        return ''.join(map(extract_txt, doc.childNodes))
        
+def is_match(key, file):
+       """!
+       Is the block key a match for the given file name?
+       @param key block key
+       @param file the xml file name
+       @return true if matches
+       """
+       _file = file.replace('.xml', '') #remove file ext       
+       _file = _file.replace('class', '') #remove the class
+       _file = _file.replace('__', '_') #doxygen xml files have 2 underscores
+       _key = key.rstrip('x') #strip x to the right to match an xml file
+       return _file.startswith(_key) and len(key) == len(_file)
+       
 def extract_docs(key):
        """!
        Extract the documentation from the doxygen generated xml files.
        If multiple files match, combine the docs.
        @param key the block key
        @return a string with documentation
-       """
-       key = key.strip('x_') #strip x and _ to match an xml file
-       key = key.replace('_', '__') #doxygen xml files have 2 underscores
+       """             
        #get potential xml file matches for the key
        if os.path.exists(DOCS_DIR) and os.path.isdir(DOCS_DIR):
-               matches = filter(lambda d: key in d, os.listdir(DOCS_DIR))
+               matches = filter(lambda f: is_match(key, f), 
os.listdir(DOCS_DIR))
        else: matches = list()
        #combine all matches
        doc_strs = list()

Copied: 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_interleaved_short.xml
 (from rev 8036, 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_ishort.xml)
===================================================================
--- 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_interleaved_short.xml
                           (rev 0)
+++ 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_interleaved_short.xml
   2008-03-21 03:54:55 UTC (rev 8065)
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!DOCTYPE block SYSTEM "../block.dtd">
+<!-- 
+###################################################
+##Complex to Interleaved Short:
+###################################################
+ -->
+<block>
+       <name>Complex To IShort</name>
+       <key>gr_complex_to_interleaved_short</key>
+       <import>from gnuradio import gr</import>
+       <make>gr.complex_to_interleaved_short()</make>
+       <sink>
+               <name>in</name>
+               <type>complex</type>
+       </sink> 
+       <source>
+               <name>out</name>
+               <type>short</type>
+       </source>
+</block>

Deleted: 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_complex_to_ishort.xml

Copied: 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_interleaved_short_to_complex.xml
 (from rev 8036, 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_ishort_to_complex.xml)
===================================================================
--- 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_interleaved_short_to_complex.xml
                           (rev 0)
+++ 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_interleaved_short_to_complex.xml
   2008-03-21 03:54:55 UTC (rev 8065)
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!DOCTYPE block SYSTEM "../block.dtd">
+<!-- 
+###################################################
+##Interleaved Short to Complex:
+###################################################
+ -->
+<block>
+       <name>IShort To Complex</name>
+       <key>gr_interleaved_short_to_complex</key>
+       <import>from gnuradio import gr</import>
+       <make>gr.interleaved_short_to_complex()</make>
+       <sink>
+               <name>in</name>
+               <type>short</type>
+       </sink> 
+       <source>
+               <name>out</name>
+               <type>complex</type>
+       </source>
+</block>

Deleted: 
grc/branches/grc_reloaded/src/grc_gnuradio/blocks/conversions/gr_ishort_to_complex.xml

Modified: grc/branches/grc_reloaded/src/grc_gnuradio/data/block_tree.xml
===================================================================
--- grc/branches/grc_reloaded/src/grc_gnuradio/data/block_tree.xml      
2008-03-20 22:46:12 UTC (rev 8064)
+++ grc/branches/grc_reloaded/src/grc_gnuradio/data/block_tree.xml      
2008-03-21 03:54:55 UTC (rev 8065)
@@ -70,8 +70,8 @@
                <block>gr_float_to_uchar</block>
                <block>gr_uchar_to_float</block>
                
-               <block>gr_complex_to_ishort</block>
-               <block>gr_ishort_to_complex</block>
+               <block>gr_complex_to_interleaved_short</block>
+               <block>gr_interleaved_short_to_complex</block>
        </cat>
        <cat>
                <name>Stream Conversions</name>