Merge pull request #268 from jpgill86/docs-citations

Add citation recommendations to docs and README

README.rst

@@ -3,7 +3,7 @@
 
 *Curate, visualize, annotate, and share your behavioral ephys data using Python*
 
-|PyPI badge| |Anaconda badge| |GitHub badge| |Feedstock badge| |Constructor badge| |Docs badge| |Travis badge| |Azure badge| |Coverage badge| |Zenodo badge|
+|PyPI badge| |Anaconda badge| |GitHub badge| |Feedstock badge| |Constructor badge| |Docs badge| |Travis badge| |Azure badge| |Coverage badge| |Zenodo badge| |eNeuro badge|
 
 Documentation_ | `Release Notes`_ | `Issue Tracker`_
 
@@ -272,6 +272,18 @@ The command line interface accepts other arguments too:
                             starting the standalone app (other args will be
                             ignored)
 
+Citing neurotic
+---------------
+
+To cite **neurotic** in your publication, please refer to:
+
+    Gill, J. P., Garcia, S., Ting, L. H., Wu, M., & Chiel, H. J. (2020).
+    **neurotic**: Neuroscience Tool for Interactive Characterization. eNeuro.
+    https://doi.org/10.1523/ENEURO.0085-20.2020
+
+Specific versions of the software can be cited from archives at Zenodo_.
+
+
 .. |neurotic logo| image:: https://raw.githubusercontent.com/jpgill86/neurotic/master/neurotic/gui/icons/img/neurotic-logo-30.png
     :alt: Project logo
 
@@ -312,8 +324,12 @@ The command line interface accepts other arguments too:
     :alt: Coverage status
 
 .. |Zenodo badge| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3564990-blue.svg
-   :target: Zenodo_
-   :alt: Zenodo archive
+    :target: Zenodo_
+    :alt: Zenodo archive
+
+.. |eNeuro badge| image:: https://img.shields.io/badge/DOI-10.1523/ENEURO.0085--20.2020-blue.svg
+    :target: eNeuro_
+    :alt: eNeuro article
 
 .. |Example screenshot| image:: https://raw.githubusercontent.com/jpgill86/neurotic/master/docs/_static/example-screenshot.png
     :target: https://raw.githubusercontent.com/jpgill86/neurotic/master/docs/_static/example-screenshot.png
@@ -328,6 +344,7 @@ The command line interface accepts other arguments too:
 .. _Configuring Metadata: https://neurotic.readthedocs.io/en/latest/metadata.html
 .. _Coveralls:      https://coveralls.io/github/jpgill86/neurotic?branch=master
 .. _Documentation:  https://neurotic.readthedocs.io/en/latest
+.. _eNeuro:         https://doi.org/10.1523/ENEURO.0085-20.2020
 .. _ephyviewer:     https://github.com/NeuralEnsemble/ephyviewer
 .. _GIN:            https://gin.g-node.org
 .. _GitHub:         https://github.com/jpgill86/neurotic

docs/citations.rst

@@ -0,0 +1,14 @@
+.. _citations:
+
+Citing neurotic
+===============
+
+To cite **neurotic** in your publication, please refer to:
+
+    Gill, J. P., Garcia, S., Ting, L. H., Wu, M., & Chiel, H. J. (2020).
+    **neurotic**: Neuroscience Tool for Interactive Characterization. eNeuro.
+    https://doi.org/10.1523/ENEURO.0085-20.2020
+
+Specific versions of the software can be cited from archives at Zenodo_.
+
+.. _Zenodo: https://doi.org/10.5281/zenodo.3564990

docs/index.rst

@@ -3,7 +3,7 @@ neurotic: NEUROscience Tool for Interactive Characterization
 
 *Curate, visualize, annotate, and share your behavioral ephys data using Python*
 
-|PyPI badge| |Anaconda badge| |GitHub badge| |Feedstock badge| |Constructor badge| |Docs badge| |Travis badge| |Azure badge| |Coverage badge| |Zenodo badge|
+|PyPI badge| |Anaconda badge| |GitHub badge| |Feedstock badge| |Constructor badge| |Docs badge| |Travis badge| |Azure badge| |Coverage badge| |Zenodo badge| |eNeuro badge|
 
 **Version:** |version| (`other versions`_)
 
@@ -25,61 +25,67 @@ at the same datasets!
    install
    update
    gettingstarted
+   citations
    metadata
    examples
    api
    releasenotes
 
 
 .. |PyPI badge| image:: https://img.shields.io/pypi/v/neurotic.svg?logo=python&logoColor=white
-   :target: PyPI_
-   :alt: PyPI project
+    :target: PyPI_
+    :alt: PyPI project
 
 .. |Anaconda badge| image:: https://img.shields.io/conda/vn/conda-forge/neurotic.svg?label=anaconda&logo=anaconda&logoColor=white
-   :target: `Anaconda Cloud`_
-   :alt: Anaconda Cloud project
+    :target: `Anaconda Cloud`_
+    :alt: Anaconda Cloud project
 
 .. |GitHub badge| image:: https://img.shields.io/badge/github-source_code-blue.svg?logo=github&logoColor=white
-   :target: GitHub_
-   :alt: GitHub source code
+    :target: GitHub_
+    :alt: GitHub source code
 
 .. |Feedstock badge| image:: https://img.shields.io/badge/conda--forge-feedstock-blue.svg?logo=conda-forge&logoColor=white
-   :target: `conda-forge feedstock`_
-   :alt: conda-forge feedstock
+    :target: `conda-forge feedstock`_
+    :alt: conda-forge feedstock
 
 .. |Constructor badge| image:: https://img.shields.io/badge/constructor-recipe-blue.svg
-   :target: `constructor recipe`_
-   :alt: constructor recipe
+    :target: `constructor recipe`_
+    :alt: constructor recipe
 
 .. |Docs badge| image:: https://img.shields.io/readthedocs/neurotic/latest.svg?logo=read-the-docs&logoColor=white
-   :target: ReadTheDocs_
-   :alt: Documentation status
+    :target: ReadTheDocs_
+    :alt: Documentation status
 
 .. |Travis badge| image:: https://img.shields.io/travis/com/jpgill86/neurotic/master.svg?logo=travis-ci&logoColor=white
-   :target: Travis_
-   :alt: Travis build status
+    :target: Travis_
+    :alt: Travis build status
 
 .. |Azure badge| image:: https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/neurotic-feedstock?branchName=master
-   :target: `conda-forge CI`_
-   :alt: conda-forge build status
+    :target: `conda-forge CI`_
+    :alt: conda-forge build status
 
 .. |Coverage badge| image:: https://coveralls.io/repos/github/jpgill86/neurotic/badge.svg?branch=master
-   :target: Coveralls_
-   :alt: Coverage status
+    :target: Coveralls_
+    :alt: Coverage status
 
 .. |Zenodo badge| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3564990-blue.svg
-   :target: Zenodo_
-   :alt: Zenodo archive
+    :target: Zenodo_
+    :alt: Zenodo archive
+
+.. |eNeuro badge| image:: https://img.shields.io/badge/DOI-10.1523/ENEURO.0085--20.2020-blue.svg
+    :target: eNeuro_
+    :alt: eNeuro article
 
 .. |Example screenshot| image:: _static/example-screenshot.png
-   :target: _static/example-screenshot.png
-   :alt: Screenshot
+    :target: _static/example-screenshot.png
+    :alt: Screenshot
 
 .. _Anaconda Cloud: https://anaconda.org/conda-forge/neurotic
 .. _constructor recipe: https://github.com/jpgill86/neurotic-constructor
 .. _conda-forge CI: https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=8417&branchName=master
 .. _conda-forge feedstock: https://github.com/conda-forge/neurotic-feedstock
 .. _Coveralls:      https://coveralls.io/github/jpgill86/neurotic?branch=master
+.. _eNeuro:         https://doi.org/10.1523/ENEURO.0085-20.2020
 .. _ephyviewer:     https://github.com/NeuralEnsemble/ephyviewer
 .. _GitHub:         https://github.com/jpgill86/neurotic
 .. _Neo:            https://github.com/NeuralEnsemble/python-neo