Merge pull request #1162 from apdavison/release-notes-0.11.0

Release notes for 0.11.0, together with some docstring changes
NeuralEnsemble · Sep 1, 2022 · 08daa63 · 08daa63
2 parents 89fd2f9 + 6d319e3
commit 08daa63
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 10 deletions.
diff --git a/doc/source/releases/0.11.0.rst b/doc/source/releases/0.11.0.rst
@@ -0,0 +1,48 @@
+========================
+Neo 0.11.0 release notes
+========================
+
+1st September 2022
+
+.. currentmodule:: neo.io
+
+Bug fixes and improvements in IO modules
+----------------------------------------
+
+Bug fixes and/or improvements have been made to :class:`NWBIO`, :class:`NeoMatlabIO`, :class:`NixIO`,
+:class:`AxonIO`, :class:`SpikeGLXIO`, :class:`NeuroshareIO`, :class:`NeuroScopeIO`,
+:class:`NeuralynxIO`, :class:`OpenEphysIO`, :class:`AsciiSignalIO`, :class:`AlphaOmegaIO`,
+and :class:`TdtIO`.
+
+New IO modules
+--------------
+
+Modules :class:`BiocamIO` and :class:`EDFIO` have been added.
+
+Supported NumPy versions
+------------------------
+
+We no longer support versions of NumPy older than 1.18.5.
+
+
+Other changes
+-------------
+
+.. currentmodule:: neo.io.spiketrainlist
+
+- documentation fixes and updates
+- improvements to :class:`SpikeTrainList`
+
+See all `pull requests`_ included in this release and the `list of closed issues`_.
+
+Acknowledgements
+----------------
+
+Thanks to Julia Sprenger, Samuel Garcia, Heberto Mayorquin, Andrew Davison, Tom Donoghue,
+Alessio Buccino, Thomas Perret, Saksham Sharda, Ben Dichter and Elodie Legouée
+for their contributions to this release.
+
+.. generated with git shortlog --since=2022-03-08 -sne then checking Github for PRs merged since the last release but with commits before then
+
+.. _`list of closed issues`: https://github.com/NeuralEnsemble/python-neo/issues?q=is%3Aissue+milestone%3A0.11.0+is%3Aclosed
+.. _`pull requests`: https://github.com/NeuralEnsemble/python-neo/pulls?q=is%3Apr+is%3Aclosed+merged%3A%3E2022-03-08+milestone%3A0.11.0
diff --git a/doc/source/whatisnew.rst b/doc/source/whatisnew.rst
@@ -6,6 +6,7 @@ Release notes
 .. toctree::
    :maxdepth: 1
 
+   releases/0.11.0.rst
    releases/0.10.2.rst
    releases/0.10.1.rst
    releases/0.10.0.rst

diff --git a/neo/io/__init__.py b/neo/io/__init__.py
@@ -30,6 +30,7 @@
 * :attr:`BrainwareF32IO`
 * :attr:`BrainwareSrcIO`
 * :attr:`CedIO`
+* :attr:`EDFIO`
 * :attr:`ElanIO`
 * :attr:`IgorIO`
 * :attr:`IntanIO`
@@ -127,6 +128,10 @@
 
     .. autoattribute:: extensions
 
+.. autoclass:: neo.io.EDFIO
+
+    .. autoattribute:: extensions
+
 .. autoclass:: neo.io.ElanIO
 
     .. autoattribute:: extensions
@@ -335,6 +340,7 @@
     AxonaIO,
     AxonIO,
     BCI2000IO,
+    BiocamIO,
     BlackrockIO,
     BlkIO,
     BrainVisionIO,

diff --git a/neo/rawio/__init__.py b/neo/rawio/__init__.py
@@ -20,7 +20,7 @@
 * :attr:`BlackrockRawIO`
 * :attr:`BrainVisionRawIO`
 * :attr:`CedRawIO`
-* :attr: `EdfRawIO`
+* :attr: `EDFRawIO`
 * :attr:`ElanRawIO`
 * :attr:`IntanRawIO`
 * :attr:`MaxwellRawIO`
@@ -76,7 +76,7 @@
 
     .. autoattribute:: extensions
 
-.. autoclass:: neo.rawio.EdfRawIO
+.. autoclass:: neo.rawio.EDFRawIO
 
     .. autoattribute:: extensions
 

diff --git a/neo/rawio/axonarawio.py b/neo/rawio/axonarawio.py
@@ -30,22 +30,23 @@ class AxonaRawIO(BaseRawIO):
     Class for reading raw, continuous data from the Axona dacqUSB system:
     http://space-memory-navigation.org/DacqUSBFileFormats.pdf
 
-    The raw data is saved in .bin binary files with an accompanying
-    .set file about the recording setup (see the above manual for details).
+    The raw data is saved in .bin binary files with an accompanying .set
+    file about the recording setup (see the above manual for details).
+
+    Usage::
 
-    Usage:
         import neo.rawio
-        r = neo.rawio.AxonaRawIO(
-            filename=os.path.join(dir_name, base_filename)
-        )
+        r = neo.rawio.AxonaRawIO(filename=os.path.join(dir_name, base_filename))
         r.parse_header()
         print(r)
         raw_chunk = r.get_analogsignal_chunk(block_index=0, seg_index=0,
-                      i_start=0, i_stop=1024,  channel_names=channel_names)
+                                             i_start=0, i_stop=1024,
+                                             channel_names=channel_names)
         float_chunk = reader.rescale_signal_raw_to_float(
             raw_chunk, dtype='float64',
             channel_indexes=[0, 3, 6]
         )
+
     """
 
     extensions = ['bin', 'set'] + [str(i) for i in range(1, 33)]  # Never used?

diff --git a/neo/rawio/edfrawio.py b/neo/rawio/edfrawio.py
@@ -30,7 +30,7 @@ class EDFRawIO(BaseRawIO):
 
     Usage:
         >>> import neo.rawio
-        >>> r = neo.rawio.EdfRawIO(filename='file.edf')
+        >>> r = neo.rawio.EDFRawIO(filename='file.edf')
         >>> r.parse_header()
         >>> print(r)
         >>> raw_chunk = r.get_analogsignal_chunk(block_index=0, seg_index=0,