Skip to content

Commit

Permalink
Added How to Cite (#1125)
Browse files Browse the repository at this point in the history
* Added How to Cite to readme.

* Added how_to_cite to read_the_docs

* added how_to_cite to index.rst
  • Loading branch information
PaulJonasJost authored Oct 10, 2023
1 parent 33da118 commit 0529fe5
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 5 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,29 @@ We are happy about any contributions. For more information on how to contribute
to pyPESTO check out
<https://pypesto.readthedocs.io/en/latest/contribute.html>

## Publications

**Citeable DOI for the latest pyPESTO release:**
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2553546.svg)](https://doi.org/10.5281/zenodo.2553546)

There is a list of [publications using pyPESTO](https://pypesto.readthedocs.io/en/latest/references.html).
If you used pyPESTO in your work, we are happy to include
your project, please let us know via a GitHub issue.

When using pyPESTO in your project, please cite
* Schälte, Y., Fröhlich, F., Jost, P. J., Vanhoefer, J., Pathirana, D., Stapor, P.,
Lakrisenko, P., Wang, D., Raimúndez, E., Merkt, S., Schmiester, L., Städter, P.,
Grein, S., Dudkin, E., Doresic, D., Weindl, D., & Hasenauer, J. (2023). pyPESTO: A
modular and scalable tool for parameter estimation for dynamic models [(arXiv:2305.01821)](https://doi.org/10.48550/arXiv.2305.01821).

When presenting work that employs pyPESTO, feel free to use one of the icons in
[doc/logo/](https://github.com/ICB-DCM/pyPESTO/tree/main/doc/logo):

<p align="center">
<img src="https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo.png" height="75" alt="AMICI Logo">
</p>

## References

[**PESTO**](https://github.com/ICB-DCM/PESTO/):
Parameter estimation toolbox for MATLAB. Development is discontinued, but PESTO
comes with additional features waiting to be ported to pyPESTO.
pyPESTO supersedes [**PESTO**](https://github.com/ICB-DCM/PESTO/) a parameter estimation
toolbox for MATLAB, whose development is discontinued.
28 changes: 28 additions & 0 deletions doc/how_to_cite.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
How to cite pyPESTO
===================

**Citeable DOI for the latest pyPESTO release:**

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2553546.svg
:target: https://doi.org/10.5281/zenodo.2553546
:alt: pyPESTO release DOI


There is a list of `publications using pyPESTO <https://pypesto.readthedocs.io/en/latest/references.html>`_.
If you used pyPESTO in your work, we are happy to include
your project, please let us know via a GitHub issue.

When using pyPESTO in your project, please cite

- Schälte, Y., Fröhlich, F., Jost, P. J., Vanhoefer, J., Pathirana, D., Stapor, P.,
Lakrisenko, P., Wang, D., Raimúndez, E., Merkt, S., Schmiester, L., Städter, P.,
Grein, S., Dudkin, E., Doresic, D., Weindl, D., & Hasenauer, J. (2023). pyPESTO: A
modular and scalable tool for parameter estimation for dynamic models `arXiv:2305.01821 <https://doi.org/10.48550/arXiv.2305.01821>`_.

When presenting work that employs pyPESTO, feel free to use one of the icons in
`doc/logo/ <https://github.com/ICB-DCM/pyPESTO/tree/main/doc/logo>`_:

.. image:: https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo.png
:target: https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo.png
:height: 75
:alt: pyPESTO LOGO
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ pyPESTO - Parameter EStimation TOolbox for python
references
contact
license
how_to_cite
logo


Expand Down
4 changes: 2 additions & 2 deletions doc/references.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Publications using pypesto
Publications using pyPESTO
==========================

pypesto was used in the following publications:
pyPESTO was used in the following publications:

.. bibliography:: using_pypesto.bib
:list: enumerated
Expand Down

0 comments on commit 0529fe5

Please sign in to comment.