Skip to content

DOC: add advive for citing nibabel #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 26, 2016
Merged

DOC: add advive for citing nibabel #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 16 additions & 0 deletions doc/source/devel/make_release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great. I have also adjusted citation injection in duecredit, also to cite nibabel if imported: yarikoptic/duecredit@f8e2c2a

I wondered now, would you mind if I submit a PR to add duecredit's "native" stub within nibabel thus avoiding necessity to inject its citation at run-time? ;)


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
Expand Down
1 change: 1 addition & 0 deletions doc/source/links_names.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions nibabel/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down