updated documentation

sneusse · May 11, 2015 · b8e9cac · b8e9cac
1 parent c6ac0a6
commit b8e9cac
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/mdf4reader.py b/mdf4reader.py
@@ -13,8 +13,9 @@
 -------------------
 - Python >2.6, >3.2 <http://www.python.org>
 - Numpy >1.6 <http://numpy.scipy.org>
-- zlib to uncompress data block if needed
+- bitarray to parse bits in not aligned bytes
 - Sympy to convert channels with formula if needed
+- zlib to uncompress data block if needed
 
 Attributes
 --------------
@@ -737,6 +738,7 @@ class record(list):
     loadInfo(info)
     readSortedRecord(fid, pointer, channelList=None)
     readRecordBuf(buf, channelList=None)
+    readBitarray(bita, channelList=None)
     """
 
     def __init__(self, dataGroup, channelGroup):
@@ -961,6 +963,7 @@ def readBitarray(self, bita, channelList=None):
         bitarray : stream
             stream of bytes
         channelList : List of str, optional
+            list of channel to read
         
         Returns
         --------

diff --git a/mdfreader.pdf b/mdfreader.pdf
diff --git a/mdfreader.py b/mdfreader.py
@@ -21,6 +21,7 @@
 - xlwt for the excel export (not existing for python3)
 - openpyxl for the excel 2007 export
 - scipy for the Matlab file conversion
+- zlib to uncompress data block if needed
 
 Attributes
 --------------

diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/development.html#single-sourcing-the-version
-    version='0.1.1',
+    version='0.1.2',
 
     description='A Measured Data Format file parser',
     long_description=long_description,
@@ -66,7 +66,7 @@
     # project is installed. For an analysis of "install_requires" vs pip's
     # requirements files see:
     # https://packaging.python.org/en/latest/technical.html#install-requires-vs-requirements-files
-    install_requires=['numpy>=1.6', 'Sympy', 'bitstring'],
+    install_requires=['numpy>=1.6', 'Sympy', 'bitarray'],
 
     # List additional groups of dependencies here (e.g. development dependencies).
     # You can install these using the following syntax, for example:

diff --git a/source/conf.py b/source/conf.py
@@ -41,16 +41,16 @@
 
 # General information about the project.
 project = u'mdfreader'
-copyright = u'2014, Aymeric Rateau'
+copyright = u'2015, Aymeric Rateau'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.9'
+version = '1.1'
 # The full version, including alpha/beta/rc tags.
-release = '0'
+release = '1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.