Merge pull request #51 from alperyeg/feature/release02

updated documentation for 0.2 release

doc/conf.py

@@ -51,9 +51,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = '0.2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/index.rst

@@ -24,6 +24,7 @@ Table of Contents
     modules
     developers_guide
     authors
+    release_notes	       
 
 
 

doc/install.rst

@@ -74,8 +74,8 @@ To download and install manually, download the latest package from http://pypi.p
 
 Then::
 
-    $ tar xzf elephant-0.1.tar.gz
-    $ cd elephant-0.1
+    $ tar xzf elephant-0.2.0.tar.gz
+    $ cd elephant-0.2.0
     $ python setup.py install
     
 or::
@@ -105,4 +105,4 @@ To install the latest version of Elephant from the Git repository::
 .. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
 .. _`this snapshot`: https://github.com/NeuralEnsemble/python-neo/archive/apibreak.zip
 .. _Anaconda: http://continuum.io/downloads
-.. _`Conda environment`: http://conda.pydata.org/docs/faq.html#creating-new-environments
+.. _`Conda environment`: http://conda.pydata.org/docs/faq.html#creating-new-environments

doc/release_notes.rst

@@ -0,0 +1,28 @@
+*************
+Release Notes
+*************
+
+Elephant 0.2.0 release notes
+==========================
+September 22nd 2015
+
+Welcome to the 0.2.0 release of Elephant!
+
+New functions
+=============
+
+* Added covariance function **covariance()** in the `spike_train_correlation` module
+* Added complexity pdf **complexity_pdf()** in the `statistics` module
+* Added spike train extraction from analog signals via threshold detection the in `spike_train_generation` module
+* Added **coherence()** function for analog signals in the `spectral` module
+* Added **Cumulant Based Inference for higher-order of Correlation (CuBIC)** in the `cubic` module for correlation analysis of parallel recorded spike trains
+
+API changes
+===========
+* **Optimized kernel bandwidth** in `rate_estimation` function: Calculates the optimized kernel width when the paramter kernel width is specified as `auto`
+
+Other changes
+=============
+* **Optimized creation of sparse matrices**: The creation speed of the sparse matrix inside the `BinnedSpikeTrain` class is optimized
+* Added **Izhikevich neuron simulator** in the `make_spike_extraction_test_data` module
+* Minor improvements to the test and continous integration infrastructure

elephant/__init__.py

@@ -21,4 +21,4 @@
 except ImportError:
     pass
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name="elephant",
-    version='0.1.0',
+    version='0.2.0',
     packages=['elephant', 'elephant.test'],
     install_requires=install_requires,
     extras_require=extras_require,