From 165276fe26174f4747a53ad27b8ca0727a9e4c28 Mon Sep 17 00:00:00 2001 From: Danylo Ulianych Date: Thu, 4 Mar 2021 19:30:01 +0100 Subject: [PATCH] Release 0.10.0 (#407) --- doc/release_notes.rst | 36 ++++++++++++++++++++++++++++++++++++ elephant/VERSION | 2 +- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/doc/release_notes.rst b/doc/release_notes.rst index 3e279d2e3..8b7cf226a 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -2,6 +2,42 @@ Release Notes ============= +Elephant 0.10.0 release notes +============================= + +Documentation +------------- +The documentation is revised and restructured by categories (https://github.com/NeuralEnsemble/elephant/pull/386) to simplify navigation on readthedocs and improve user experience. All citations used in Elephant are stored in a single [BibTex file](https://github.com/NeuralEnsemble/elephant/blob/master/doc/bib/elephant.bib). + +Optimizations +------------- + +CUDA and OpenCL support +*********************** +[Analysis of Sequences of Synchronous EvenTs](https://elephant.readthedocs.io/en/latest/reference/asset.html) has become the first module in Elephant that supports CUDA and OpenCL (https://github.com/NeuralEnsemble/elephant/pull/351, https://github.com/NeuralEnsemble/elephant/pull/404, https://github.com/NeuralEnsemble/elephant/pull/399). Whether you have an Nvidia GPU or just run the analysis on a laptop with a built-in Intel graphics card, the speed-up is **X100** and **X1000** compared to a single CPU core. The computations are optimized to a degree that you can analyse and look for spike patterns in real data in several minutes of compute time on a laptop. The installation instructions are described in the [install](https://elephant.readthedocs.io/en/latest/install.html) section. + +Other optimizations +******************* +* Surrogates: sped up bin shuffling (https://github.com/NeuralEnsemble/elephant/pull/400) and reimplemented the continuous time version (https://github.com/NeuralEnsemble/elephant/pull/397) +* Improved memory efficiency of creating a BinnedSpikeTrain (https://github.com/NeuralEnsemble/elephant/pull/395) + +New functionality and features +------------------------------ +* Synchrofact detection (https://github.com/NeuralEnsemble/elephant/pull/322) is a method to detect highly synchronous spikes (at the level of sampling rate precision with an option to extend this to jittered synchrony) and annotate or optionally remove them. +* Added `phase_locking_value`, `mean_phase_vector`, and `phase_difference` functions (https://github.com/NeuralEnsemble/elephant/pull/385/files) +* BinnedSpikeTrain: + - added `to_spike_trains` and `time_slice` functions (https://github.com/NeuralEnsemble/elephant/pull/390). Now you can slice a binned spike train as `bst[:, i:j]` or `bst.time_slice(t_start, t_stop)`. Also, with `to_spike_trains` function, you can generate a realization of spike trains that maps to the same BinnedSpikeTrain object when binned. + - optional CSC format (https://github.com/NeuralEnsemble/elephant/pull/402) + - the `copy` parameter (False by default) in the `binarize` function makes a *shallow* copy, if set to True, of the output BinnedSpikeTrain object (https://github.com/NeuralEnsemble/elephant/pull/402) +* Granger causality tutorial notebook (https://github.com/NeuralEnsemble/elephant/pull/393) +* Unitary Event Analysis support multiple pattern hashes (https://github.com/NeuralEnsemble/elephant/pull/387) + +Bug fixes +--------- +* Account for unidirectional spiketrain->segment links in synchrofact deletion (https://github.com/NeuralEnsemble/elephant/pull/398) +* Joint-ISI dithering: fixed a bug regarding first ISI bin (https://github.com/NeuralEnsemble/elephant/pull/396) +* Fix LvR values from being off when units are in seconds (https://github.com/NeuralEnsemble/elephant/pull/389) + Elephant 0.9.0 release notes **************************** diff --git a/elephant/VERSION b/elephant/VERSION index 899f24fc7..2774f8587 100644 --- a/elephant/VERSION +++ b/elephant/VERSION @@ -1 +1 @@ -0.9.0 \ No newline at end of file +0.10.0 \ No newline at end of file