Acknowledgments (NeuralEnsemble#241)

* acknowledgments * removed reference file AUTHORS.txt * recursive-exclude . *~
INM-6 · Jul 23, 2019 · d6822d6 · d6822d6
1 parent 6fd3a5b
commit d6822d6
Show file tree

Hide file tree

Showing 43 changed files with 68 additions and 64 deletions.
diff --git a/AUTHORS.txt b/AUTHORS.txt
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,8 +1,7 @@
 recursive-include elephant *.py
 include requirements*.txt
-include README.rst
+include README.md
 include LICENSE.txt
-include AUTHORS.txt
 include elephant/VERSION
 include elephant/current_source_density_src/README.md
 include elephant/current_source_density_src/test_data.mat
@@ -11,3 +10,4 @@ recursive-include elephant/spade_src *.so *.pyd
 include elephant/test/spike_extraction_test_data.txt
 recursive-include doc *
 prune doc/_build
+recursive-exclude . *~
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# Elephant - Electrophysiology Analysis Toolkit
+
+Elephant is a package for the analysis of neurophysiological data, based on Neo.
+
+## Code status
+
+![](https://travis-ci.org/NeuralEnsemble/elephant.png?branch=master "Unit Test Status")
+![](https://coveralls.io/repos/NeuralEnsemble/elephant/badge.png "Unit Test Coverage")
+![](https://requires.io/github/NeuralEnsemble/elephant/requirements.png?branch=master "Requirements Status")
+![](https://readthedocs.org/projects/elephant/badge/?version=latest "Documentation Status")
+
+#### Copyright
+
+:copyright: 2014-2019 by the [Elephant team](doc/authors.rst).
+
+#### License
+
+Modified BSD License, see [LICENSE.txt](LICENSE.txt) for details.
+
+#### Acknowledgments
+
+See [acknowledgments](doc/acknowledgments.rst).
diff --git a/README.rst b/README.rst
diff --git a/doc/acknowledgments.rst b/doc/acknowledgments.rst
@@ -0,0 +1,5 @@
+***************
+Acknowledgments
+***************
+
+This open source software code was developed in part or in whole in the Human Brain Project, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under Specific Grant Agreements No. 720270 and No. 785907 (Human Brain Project SGA1 and SGA2).
diff --git a/doc/index.rst b/doc/index.rst
@@ -25,7 +25,8 @@ Table of Contents
     modules
     developers_guide
     authors
-    release_notes	       
+    release_notes
+    acknowledgements
 
 
 

diff --git a/elephant/__init__.py b/elephant/__init__.py
@@ -2,7 +2,7 @@
 """
 Elephant is a package for the analysis of neurophysiology data, based on Neo.
 
-:copyright: Copyright 2014-2019 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2019 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/conversion.py b/elephant/conversion.py
@@ -6,7 +6,7 @@
 An example is the representation of a spike train as a sequence of 0-1 values
 (binned spike train).
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/cubic.py b/elephant/cubic.py
@@ -14,7 +14,7 @@
        >>> alpha = 0.05  # significance level of the tests used
        >>> xi, p_val, k = cubic(data, ximax=100, alpha=0.05, errorval=4.):
 
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: BSD, see LICENSE.txt for details.
 '''
 # -*- coding: utf-8 -*-

diff --git a/elephant/kernels.py b/elephant/kernels.py
@@ -8,7 +8,7 @@
     >>> kernel1 = kernels.GaussianKernel(sigma=100*ms)
     >>> kernel2 = kernels.ExponentialKernel(sigma=8*mm, invert=True)
     
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/neo_tools.py b/elephant/neo_tools.py
@@ -2,7 +2,7 @@
 """
 Tools to manipulate Neo objects.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/pandas_bridge.py b/elephant/pandas_bridge.py
@@ -2,7 +2,7 @@
 """
 Bridge to the pandas library.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/phase_analysis.py b/elephant/phase_analysis.py
@@ -2,7 +2,7 @@
 """
 Methods for performing phase analysis.
 
-:copyright: Copyright 2014-2018 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2018 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/signal_processing.py b/elephant/signal_processing.py
@@ -3,7 +3,7 @@
 Basic processing procedures for analog signals (e.g., performing a z-score of a
 signal, or filtering a signal).
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 '''
 

diff --git a/elephant/spade.py b/elephant/spade.py
@@ -53,7 +53,7 @@
 plt.legend()
 plt.show()
 
-:copyright: Copyright 2017 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2017 by the Elephant team, see `doc/authors.rst`.
 :license: BSD, see LICENSE.txt for details.
 '''
 import numpy

diff --git a/elephant/spectral.py b/elephant/spectral.py
@@ -3,7 +3,7 @@
 Identification of spectral properties in analog signals (e.g., the power
 spectrum).
 
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/spike_train_correlation.py b/elephant/spike_train_correlation.py
@@ -2,7 +2,7 @@
 """
 This modules provides functions to calculate correlations between spike trains.
 
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 from __future__ import division

diff --git a/elephant/spike_train_dissimilarity.py b/elephant/spike_train_dissimilarity.py
@@ -9,7 +9,7 @@
 Van Rossum distance implemented in this module, which both are metrics in the
 mathematical sense and time-scale dependent.
 
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/spike_train_generation.py b/elephant/spike_train_generation.py
@@ -6,7 +6,7 @@
 Some functions are based on the NeuroTools stgen module, which was mostly
 written by Eilif Muller, or from the NeuroTools signals.analogs module.
 
-:copyright: Copyright 2015 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/spike_train_surrogates.py b/elephant/spike_train_surrogates.py
@@ -31,7 +31,7 @@
     Operational Time. Front Comput Neurosci. 2010; 4: 127.
 
 Original implementation by: Emiliano Torre [e.torre@fz-juelich.de]
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/sta.py b/elephant/sta.py
@@ -3,7 +3,7 @@
 Functions to calculate spike-triggered average and spike-field coherence of
 analog signals.
 
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 '''
 

diff --git a/elephant/statistics.py b/elephant/statistics.py
@@ -2,7 +2,7 @@
 """
 Statistical measures of spike trains (e.g., Fano factor) and functions to estimate firing rates.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_asset.py b/elephant/test/test_asset.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the ASSET analysis.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_conversion.py b/elephant/test/test_conversion.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the conversion module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_cubic.py b/elephant/test/test_cubic.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the CUBIC analysis.
 
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_kernels.py b/elephant/test/test_kernels.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the kernels module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_neo_tools.py b/elephant/test/test_neo_tools.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the neo_tools module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_pandas_bridge.py b/elephant/test/test_pandas_bridge.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the pandas bridge module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_phase_analysis.py b/elephant/test/test_phase_analysis.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the phase analysis module.
 
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 from __future__ import division, print_function

diff --git a/elephant/test/test_signal_processing.py b/elephant/test/test_signal_processing.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the signal_processing module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 from __future__ import division, print_function

diff --git a/elephant/test/test_spade.py b/elephant/test/test_spade.py
@@ -1,7 +1,7 @@
 """
 Unit tests for the spade module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 from __future__ import division

diff --git a/elephant/test/test_spectral.py b/elephant/test/test_spectral.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the spectral module.
 
-:copyright: Copyright 2015 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_spike_train_correlation.py b/elephant/test/test_spike_train_correlation.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the spike_train_correlation module.
 
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_spike_train_dissimilarity.py b/elephant/test/test_spike_train_dissimilarity.py
@@ -2,7 +2,7 @@
 """
 Tests for the spike train dissimilarity measures module.
 
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_spike_train_generation.py b/elephant/test/test_spike_train_generation.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the spike_train_generation module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_spike_train_surrogates.py b/elephant/test/test_spike_train_surrogates.py
@@ -2,7 +2,7 @@
 """
 unittests for spike_train_surrogates module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_sta.py b/elephant/test/test_sta.py
@@ -2,7 +2,7 @@
 """
 Tests for the function sta module
 
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_statistics.py b/elephant/test/test_statistics.py
@@ -2,7 +2,7 @@
 """
 Unit tests for the statistics module.
 
-:copyright: Copyright 2014-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 from __future__ import division

diff --git a/elephant/test/test_unitary_event_analysis.py b/elephant/test/test_unitary_event_analysis.py
@@ -1,7 +1,7 @@
 """
 Unit tests for the Unitary Events analysis
 
-:copyright: Copyright 2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/test/test_waveform_features.py b/elephant/test/test_waveform_features.py
@@ -1,7 +1,7 @@
 """
 Unit tests for the waveform_feature module.
 
-:copyright: Copyright 2014-2019 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2014-2019 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """
 

diff --git a/elephant/unitary_event_analysis.py b/elephant/unitary_event_analysis.py
@@ -15,7 +15,7 @@
   - Gruen S (2009) Data-driven significance estimation of precise spike
     correlation. J Neurophysiology 101:1126-1140 (invited review)
 
-:copyright: Copyright 2015-2016 by the Elephant team, see AUTHORS.txt.
+:copyright: Copyright 2015-2016 by the Elephant team, see `doc/authors.rst`.
 :license: Modified BSD, see LICENSE.txt for details.
 """