Skip to content
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

from the readme, link to the docs citation section, to DRY #222

Merged
merged 1 commit into from
Mar 8, 2021
Merged

from the readme, link to the docs citation section, to DRY #222

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
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,4 @@ Standard MIT disclaimer applies, see `DISCLAIMER.md` for full text. Development

## How to cite

To credit KeplerMapper in your work, please cite both the [JOSS paper](https://doi.org/10.21105/joss.01315) and the [Zenodo archive](https://doi.org/10.5281/zenodo.1002377). The former provides a high level description of the package, and the latter points to a permanent record of all KeplerMapper versions (we encourage you to cite the specific version you used). Example citations (for KeplerMapper 1.4.1):

van Veen et al., (2019). Kepler Mapper: A flexible Python implementation of the Mapper algorithm. Journal of Open Source Software, 4(42), 1315, https://doi.org/10.21105/joss.01315

Hendrik Jacob van Veen, Nathaniel Saul, David Eargle, & Sam W. Mangham. (2019, October 14). Kepler Mapper: A flexible Python implementation of the Mapper algorithm (Version 1.4.1). Zenodo. http://doi.org/10.5281/zenodo.4077395
To credit KeplerMapper in your work: https://kepler-mapper.scikit-tda.org/en/latest/#citations
11 changes: 7 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

|DOI| |PyPI version| |Downloads|
|Build Status| |Codecov|
|PyPI version| |Downloads| |Build Status|
|Codecov| |DOI zenodo| |DOI JOSS|

Kepler Mapper
----------------
Expand Down Expand Up @@ -93,6 +93,7 @@ We welcome contributions of all shapes and sizes. There are lots of opportunitie

To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.

.. include:: ../README.rst

.. toctree::
:hidden:
Expand Down Expand Up @@ -133,5 +134,7 @@ To contribute please fork the project make your changes and submit a pull reques
:target: https://travis-ci.org/scikit-tda/kepler-mapper
.. |Codecov| image:: https://codecov.io/gh/scikit-tda/kepler-mapper/branch/master/graph/badge.svg
:target: https://codecov.io/gh/scikit-tda/kepler-mapper
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1054444.svg
:target: https://doi.org/10.5281/zenodo.1054444
.. |DOI JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.01315/status.svg
:target: https://doi.org/10.21105/joss.01315
.. |DOI zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1002377.svg
:target: https://doi.org/10.5281/zenodo.1002377