Skip to content

Commit 0fec040

Browse files
apdavisonapdavison
committed
Re-ordered sections in release notes to put the biggest changes first.
1 parent 0b6aeef commit 0fec040

File tree

3 files changed

+62
-60
lines changed

3 files changed

+62
-60
lines changed

‎doc/source/releases/0.10.0.rst‎

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,61 +2,62 @@
22
Neo 0.10.0 release notes
33
========================
44

5-
9th July 2021
5+
27th July 2021
6+
7+
8+
New IO modules
9+
--------------
10+
11+
.. currentmodule:: neo.io
12+
13+
* :class:`CedIO` - an alternative to :class:`Spike2IO`
14+
* :class:`AxonaIO`
15+
* :class:`OpenEphysIO` - handle the binary format
16+
* :class:`PhyIO`
17+
* :class:`SpikeGLXIO`
18+
* :class:`NWBIO` - support for a subset of the `NWB:N`_ format
19+
* :class:`MaxwellIO`
20+
21+
22+
Bug fixes and improvements in IO modules
23+
----------------------------------------
24+
25+
* :class:`NeuralynxIO` was refactored and now supports new file versions (neuraview) and single file loading.
26+
* Legacy versions of old IOs were removed for NeuralynxIO (neuralynxio_v1), BlackrockIO, NeoHdf5IO.
27+
* :class:`NixIOfr` now supports array annotations of :class:`AnalogSignal` objects.
28+
* The IO modules of this release have been tested with version 0.1.0 of the `ephy_testing_data`_.
29+
* :class:`NSDFIO` was removed because we can no longer maintain it.
30+
* all IOs now accept :class:`pathlib.Path` objects.
631

732

833
Removal of Unit and ChannelIndex
934
--------------------------------
10-
In version 0.9.0 :class:`Group` and :class:`ChannelView` replace :class:`Unit` and :class:`ChannelIndex`.
11-
In this version the deprecated :class:`Unit` and :class:`ChannelIndex` are removed and only the new class:`Group` and :class:`ChannelView` objects are available.
1235

36+
.. currentmodule:: neo.core
1337

38+
In version 0.9.0 :class:`Group` and :class:`ChannelView` were introduced, replacing :class:`Unit` and :class:`ChannelIndex`, which were deprecated.
39+
In this version the deprecated :class:`Unit` and :class:`ChannelIndex` are removed and only the new :class:`Group` and :class:`ChannelView` objects are available.
1440

1541
Supported Python and NumPy versions
1642
-----------------------------------
1743

1844
We no longer support Python 3.6, nor versions of NumPy older than 1.16.
1945

20-
2146
Other new or modified features
2247
------------------------------
2348

24-
See all `pull requests`_ included in this release and the `list of closed issues`_.
25-
* SpikeTrain can now also be provided as two arrays: one containing spike times
26-
and the other unit identities of the times (:class:`SpikeTrainList`)
27-
* Object identity is now preserved when using utility time_slice methods
28-
29-
30-
New IO modules
31-
--------------
49+
* Lists of :class:`SpikeTrain` objects can now also be created from two arrays: one containing spike times
50+
and the other unit identities of the times (:class:`SpikeTrainList`).
51+
* Object identity is now preserved when using utility :func:`time_slice()` methods.
3252

33-
* CEDIO - an alternative to spike2io
34-
* AxonaIO
35-
* OpenEphysIO - handle the binary format
36-
* PhyIO
37-
* SpikeGLXIO
38-
* NWBIO
39-
* MaxwellIO
53+
See all `pull requests`_ included in this release and the `list of closed issues`_.
4054

4155
RawIO modules
4256
-------------
4357

4458
Internal refactoring of the neo.rawio module about the channel grouping.
45-
There is a signal_stream filed that handle channel groups for signal.
46-
This enhanced the way annotation and array_annotaion are rendered at neo.io level.
47-
48-
49-
Bug fixes and improvements in IO modules
50-
----------------------------------------
51-
52-
* The NeuralynxIO was refactored and now supports new file versions (neuraview) and single file loading.
53-
* Legacy versions of old IOs were removed for NeuralynxIO (neuralynxio_v1), BlackrockIO, NeoHdf5IO
54-
* NixIOfr now supports array annotations of :class:`AnalogSignal`s.
55-
* The IO modules of this release have been tested with version 0.1.0 of the
56-
`ephy_testing_data`_
57-
* NSDFIO was removed
58-
* all IOs now accept `pathlib.Path` objects
59-
59+
There is a signal_stream field that handles channel groups for signals.
60+
This enhances the way the :attr:`annotation` and :attr:`array_annotation` attributes are rendered at neo.io level.
6061

6162
Acknowledgements
6263
----------------
@@ -67,4 +68,5 @@ Ben Dichter and Elodie Legouée for their contributions to this release.
6768

6869
.. _`list of closed issues`: https://github.com/NeuralEnsemble/python-neo/issues?q=is%3Aissue+milestone%3A0.10.0+is%3Aclosed
6970
.. _`pull requests`: https://github.com/NeuralEnsemble/python-neo/pulls?q=is%3Apr+is%3Aclosed+merged%3A%3E2020-11-10+milestone%3A0.10.0
70-
.. _`ephy_test_data`: https://gin.g-node.org/NeuralEnsemble/ephy_testing_data/src/v0.1.0
71+
.. _`ephy_testing_data`: https://gin.g-node.org/NeuralEnsemble/ephy_testing_data/src/v0.1.0
72+
.. _`NWB:N`: https://www.nwb.org/nwb-neurophysiology/

‎doc/source/releases/0.8.0.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -70,25 +70,25 @@ returning an :class:`AnalogSignal` object::
7070
Other new features
7171
------------------
7272

73-
* new neo.utils module
74-
* Numpy 1.16+ compatibility
75-
* :meth:`time_shift()` method for :class:`Epoch`/:class:`Event`/:class:`AnalogSignal`
76-
* :meth:`time_slice()` method is now more robust
77-
* dropped support for Python 3.4
73+
* new neo.utils module
74+
* Numpy 1.16+ compatibility
75+
* :meth:`time_shift()` method for :class:`Epoch`/:class:`Event`/:class:`AnalogSignal`
76+
* :meth:`time_slice()` method is now more robust
77+
* dropped support for Python 3.4
7878

7979
See all `pull requests`_ included in this release and the `list of closed issues`_.
8080

8181
Bug fixes and improvements in IO modules
8282
----------------------------------------
8383

84-
* Blackrock
85-
* Neuroshare
86-
* NixIOFr
87-
* NixIO (array annotation + 1d coordinates)
88-
* AsciiSignal (fix + json metadata + IrregularlySampledSignals + write proxy)
89-
* Spike2 (group same sampling rate)
90-
* Brainvision
91-
* NeuralynxIO
84+
* Blackrock
85+
* Neuroshare
86+
* NixIOFr
87+
* NixIO (array annotation + 1d coordinates)
88+
* AsciiSignal (fix + json metadata + IrregularlySampledSignals + write proxy)
89+
* Spike2 (group same sampling rate)
90+
* Brainvision
91+
* NeuralynxIO
9292

9393
.. Warning:: Some IOs (based on rawio) when loading can choose to split each
9494
channel into its own 1-channel :class:`AnalogSignal` or to group them

‎doc/source/releases/0.9.0.rst‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,24 +54,24 @@ To get the "multiple single-channel signals" behaviour, use::
5454
Other new or modified features
5555
------------------------------
5656

57-
* added methods :func:`rectify()`, :func:`downsample` and :func:`resample` to :class:`AnalogSignal`
58-
* :func:`SpikeTrain.merge()` can now merge multiple spiketrains
59-
* the utility function :func:`cut_block_by_epochs()` gives a new :class:`Block` now
60-
rather than modifying the block in place
61-
* some missing properties such as ``t_start`` were added to :class:`ImageSequence`,
62-
and ``sampling_period`` was renamed to ``frame_duration``
63-
* :func:`AnalogSignal.time_index()` now accepts arrays of times, not just a scalar.
57+
* added methods :func:`rectify()`, :func:`downsample` and :func:`resample` to :class:`AnalogSignal`
58+
* :func:`SpikeTrain.merge()` can now merge multiple spiketrains
59+
* the utility function :func:`cut_block_by_epochs()` gives a new :class:`Block` now
60+
rather than modifying the block in place
61+
* some missing properties such as ``t_start`` were added to :class:`ImageSequence`,
62+
and ``sampling_period`` was renamed to ``frame_duration``
63+
* :func:`AnalogSignal.time_index()` now accepts arrays of times, not just a scalar.
6464

6565
See all `pull requests`_ included in this release and the `list of closed issues`_.
6666

6767
Bug fixes and improvements in IO modules
6868
----------------------------------------
6969

70-
* NeoMatlabIO (support for signal annotations)
71-
* NeuralynxIO (fix handling of empty .nev files)
72-
* AxonIO (support EDR3 header, fix channel events bug)
73-
* Spike2IO (fix rounding problem, fix for v9 SON files)
74-
* MicromedIO (fix label encoding)
70+
* NeoMatlabIO (support for signal annotations)
71+
* NeuralynxIO (fix handling of empty .nev files)
72+
* AxonIO (support EDR3 header, fix channel events bug)
73+
* Spike2IO (fix rounding problem, fix for v9 SON files)
74+
* MicromedIO (fix label encoding)
7575

7676

7777
Acknowledgements

0 commit comments

Comments
 (0)