Merge pull request #483 from matthew-brett/zenodo-dois

DOC: add advice for citing nibabel

Zenodo DOIs and instructions for making them.

Author: matthew-brett

README.rst

@@ -77,3 +77,13 @@ License
 Nibabel is licensed under the terms of the MIT license. Some code included
 with nibabel is licensed under the BSD license.  Please see the COPYING file
 in the nibabel distribution.
+
+Citing nibabel
+==============
+
+Please see the `available releases`_ for the release of nibabel that you are
+using.  Recent releases have a Zenodo_ `Digital Object Identifier`_ badge at
+the top of the release notes.  Click on the badge for more information.
+
+.. _zenodo: https://zenodo.org
+.. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier

doc/source/devel/make_release.rst

@@ -292,6 +292,22 @@ Release checklist
     Please take a look at the Makefile rules ``devel-src``, ``devel-dsc`` and
     ``orig-src``.
 
+* Go to: https://github.com/nipy/nibabel/tags and select the new tag, to fill
+  in the release notes.  Copy the relevant part of the Changelog into the
+  release notes.  Click on "Publish release".  This will cause Zenodo_ to
+  generate a new release "upload", including a DOI.  After a few minutes, go
+  to https://zenodo.org/deposit and click on the new release upload.  Click on
+  the "View" button and click on the DOI badge at the right to display the
+  text for adding a DOI badge in various formats. Copy the DOI Markdown text.
+  The markdown will look something like this::
+
+    [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.60847.svg)](http://dx.doi.org/10.5281/zenodo.60847)
+
+  Go back to the Github release page for this release, click "Edit release".
+  and copy the DOI into the release notes.  Click "Update release".
+
+  See: https://guides.github.com/activities/citable-code
+
 * Announce to the mailing lists.
 
 .. _setuptools intro: https://pythonhosted.org/an_example_pypi_project/setuptools.html

doc/source/links_names.txt

@@ -42,6 +42,7 @@
 .. _reST: http://docutils.sourceforge.net/rst.html
 .. _docutils: http://docutils.sourceforge.net
 .. _IPython notebook viewer: http://nbviewer.ipython.org
+.. _zenodo: https://zenodo.org
 
 .. Licenses
 .. _GPL: https://www.gnu.org/licenses/gpl.html

nibabel/info.py

@@ -170,6 +170,16 @@ def cmp_pkg_version(version_str, pkg_version_str=__version__):
 Nibabel is licensed under the terms of the MIT license. Some code included
 with nibabel is licensed under the BSD license.  Please see the COPYING file
 in the nibabel distribution.
+
+Citing nibabel
+==============
+
+Please see the `available releases`_ for the release of nibabel that you are
+using.  Recent releases have a Zenodo_ `Digital Object Identifier`_ badge at
+the top of the release notes.  Click on the badge for more information.
+
+.. _zenodo: https://zenodo.org
+.. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier
 """
 
 # versions for dependencies. Check these against: