Refactored Spike Contrast method

.travis.yml

@@ -12,6 +12,7 @@ matrix:
     - name: "conda 2.7"
       python: 2.7
       env: DISTRIB="conda"
+      before_install: sed -i 's/conda-forge/conda/g' requirements/environment.yml
 
     - name: "pip 2.7"
       python: 2.7
@@ -41,6 +42,18 @@ matrix:
       python: 3.8
       env: DISTRIB="pip"
 
+    - name: "docs"
+      python: 3.6
+      env: DISTRIB="conda"
+      before_install: sudo apt install -y libopenmpi-dev openmpi-bin
+      before_script:
+        - conda install -c conda-forge pandoc
+        - pip install -r requirements/requirements-docs.txt
+        - pip install -r requirements/requirements-tutorials.txt
+        - pip install -r requirements/requirements-extras.txt
+        - sed -i -E "s/nbsphinx_execute *=.*/nbsphinx_execute = 'always'/g" doc/conf.py
+      script: cd doc && make html
+
 install:
   - if [[ "${DISTRIB}" == "conda" ]];
     then

README.md

@@ -4,7 +4,7 @@
 ![](https://coveralls.io/repos/NeuralEnsemble/elephant/badge.png "Unit Test Coverage")
 ![](https://readthedocs.org/projects/elephant/badge/?version=latest "Documentation Status")
 ![](https://img.shields.io/pypi/v/elephant)
-![](https://img.shields.io/pypi/dd/elephant)
+![](https://img.shields.io/pypi/dm/elephant)
 [![Gitter](https://badges.gitter.im/python-elephant/community.svg)](https://gitter.im/python-elephant/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 *Elephant* package analyses all sorts of neurophysiological data:

doc/release_notes.rst

@@ -2,6 +2,34 @@
 Release Notes
 *************
 
+Elephant 0.8.0 release notes
+============================
+
+New features
+------------
+* The `parallel` module is a new experimental module (https://github.com/NeuralEnsemble/elephant/pull/307) to run python functions concurrently. Supports native (pythonic) ProcessPollExecutor and MPI. Not limited to Elephant functional.
+* Added an optional `refractory_period` argument, set to None by default, to `dither_spikes` function (https://github.com/NeuralEnsemble/elephant/pull/297).
+* Added `cdf` and `icdf` functions in Kernel class to correctly estimate the median index, needed for `instantaneous_rate` function in statistics.py (https://github.com/NeuralEnsemble/elephant/pull/313).
+* Added an optional `center_kernel` argument, set to True by default (to behave as in Elephant <0.8.0 versions) to `instantaneous_rate` function in statistics.py (https://github.com/NeuralEnsemble/elephant/pull/313).
+
+New tutorials
+-------------
+* Analysis of Sequences of Synchronous EvenTs (ASSET) tutorial: https://elephant.readthedocs.io/en/latest/tutorials/asset.html
+* Parallel module tutorial: https://elephant.readthedocs.io/en/latest/tutorials/parallel.html
+
+Optimization
+------------
+* Optimized ASSET runtime by a factor of 10 and more (https://github.com/NeuralEnsemble/elephant/pull/259, https://github.com/NeuralEnsemble/elephant/pull/333).
+
+Python 2.7 and 3.5 deprecation
+------------------------------
+Python 2.7 and 3.5 are deprecated and will not be maintained by the end of 2020. Switch to Python 3.6+.
+
+Breaking changes
+----------------
+* Naming convention changes (`binsize` -> `bin_size`, etc.) in almost all Elephant functions (https://github.com/NeuralEnsemble/elephant/pull/316).
+
+
 Elephant 0.7.0 release notes
 ============================
 

doc/style_guide.rst

@@ -42,6 +42,10 @@ throughout Elephant.
 
 .. code-block:: python
 
+    def pair_of_signals_example(spiketrain_i, spiketrain_j):
+        # Add '_i' and '_j' suffixes to a pair of signals, spiketrains or any
+        # other variables that come in pairs.
+
     def perfect_naming_of_parameters(spiketrains, spiketrain, reference_spiketrain,
                          target_spiketrain, signal, signals, max_iterations,
                          min_threshold, n_bins, n_surrogates, bin_size, max_size,
@@ -119,9 +123,8 @@ throughout Elephant.
             Therefore, do not use terms as `n` or `n_surr`, that are not
             immediately understood.
         bin_size : pq.Quantity or int
-            Separate the words by underscore. Do not use `binsize`. Old functions
-            which use `binsize` will be gradually refactored to conform to the new
-            convention.
+            Separate the words by underscore. Do not use `bin_size`. Old functions
+            which use `binsize` are deprecated.
         max_size : float
             Another example showing that words should be separated by underscores.
             This intersects with the naming convention for a maximum value.