Skip to content

Commit

Permalink
Added link to paper to README and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
1313e committed Oct 8, 2020
1 parent 2dd7a07 commit 74cb4d4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:target: https://prism-tool.readthedocs.io/en/latest
:alt: PRISM Logo

|PyPI| |Python| |Azure| |ReadTheDocs| |Coverage| |Gitter|
|PyPI| |Python| |Azure| |ReadTheDocs| |Coverage| |Gitter| |arXiv|

Model dispersion with *PRISM*; an alternative to MCMC for rapid analysis of models
==================================================================================
Expand Down Expand Up @@ -148,7 +148,7 @@ Users are highly encouraged to make contributions to the package or request new
If you would like to contribute to the package, but do not know what, then there are quite a few ToDos in the code that may give you some inspiration.
As with contributions, if you find a problem or issue with *PRISM*, please do not hesitate to open a `GitHub issue`_ about it or post it on `Gitter`_.

And, finally, if you use *PRISM* as part of your workflow in a scientific publication, please consider including an acknowledgement like *"Parts of the results in this work were derived using the PRISM Python package."* and citing the *PRISM* pipeline paper:
And, finally, if you use *PRISM* as part of your workflow in a scientific publication, please consider including an acknowledgement like *"Parts of the results in this work were derived using the PRISM Python package."* and citing the *PRISM* pipeline `paper`_:

::

Expand All @@ -175,6 +175,7 @@ And, finally, if you use *PRISM* as part of your workflow in a scientific public
.. _BSD-3 license: https://github.com/1313e/PRISM/raw/master/LICENSE
.. _GitHub issue: https://github.com/1313e/PRISM/issues
.. _Gitter: https://gitter.im/1313e/PRISM
.. _paper: https://arxiv.org/abs/1901.08725

Acknowledgements
================
Expand All @@ -199,3 +200,6 @@ Huge thanks to James Josephides for making the *PRISM* logo.
.. |Gitter| image:: https://img.shields.io/gitter/room/1313e/PRISM.svg?logo=gitter&logoColor=white&label=Chat
:target: https://gitter.im/1313e/PRISM
:alt: Gitter - Chat Room
.. |arXiv| image:: https://img.shields.io/badge/arXiv-1901.08725-brightgreen
:target: https://arxiv.org/abs/1901.08725
:alt: arXiv - Paper
3 changes: 2 additions & 1 deletion docs/source/community_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ Users are highly encouraged to make contributions to the package or request new
If you would like to contribute to the package, but do not know what, then there are quite a few ToDos in the code that may give you some inspiration.
As with contributions, if you find a problem or issue with *PRISM*, please do not hesitate to open a `GitHub issue`_ about it or post it on `Gitter`_.

And, finally, if you use *PRISM* as part of your workflow in a scientific publication, please consider including an acknowledgement like *"Parts of the results in this work were derived using the PRISM Python package."* and citing the *PRISM* pipeline paper using the BibTeX-entry below.
And, finally, if you use *PRISM* as part of your workflow in a scientific publication, please consider including an acknowledgement like *"Parts of the results in this work were derived using the PRISM Python package."* and citing the *PRISM* pipeline `paper`_ using the BibTeX-entry below.

.. _GitHub issue: https://github.com/1313e/PRISM/issues
.. _Gitter: https://gitter.im/1313e/PRISM
.. _paper: https://arxiv.org/abs/1901.08725

.. role:: pycode(code)
:language: python3
Expand Down

0 comments on commit 74cb4d4

Please sign in to comment.