Skip to content

Commit

Permalink
Mention CITATION.cff in docs cite.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
morganjwilliams committed Oct 29, 2024
1 parent 50c4cd4 commit 4848faa
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/source/cite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@ Citation

|doibadages|

.. note:: :mod:`pyrolite` began as a personal project, but as the project develops
there are likely to be other contributors. Check the
`Contributors list <./contributors.html>`__ and add major contributors as
authors.

If you use :mod:`pyrolite` extensively for your research, citation of the software
would be particularly appreciated. It helps quantify the impact of the project
(assisting those contributing through paid and volunteer work), and is one way to get
the message out and help build the pyrolite community.

.. note:: :mod:`pyrolite` began as a personal project, but as the project develops
there are likely to be other contributors. Check the
`Contributors list <./contributors.html>`__ and add major contributors as
authors. A `CITATION.cff file <https://github.com/morganjwilliams/pyrolite/blob/main/CITATION.cff>`__
has also been added to the repository, providing automated citation via GitHub.


:mod:`pyrolite` has been published in the Journal of Open Source Software (JOSS),
and generally this paper is what you should cite. This paper was published in reference
to :mod:`pyrolite` v0.2.7; if you're using a different version please note that in the
Expand Down

0 comments on commit 4848faa

Please sign in to comment.