Skip to content

Commit

Permalink
Update citing information
Browse files Browse the repository at this point in the history
  • Loading branch information
enekomartinmartinez committed Oct 17, 2022
1 parent cae1c90 commit bcfa211
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![PyPI version](https://badge.fury.io/py/pysd.svg)](https://badge.fury.io/py/pysd)
[![PyPI status](https://img.shields.io/pypi/status/pysd.svg)](https://pypi.python.org/pypi/pysd/)
[![Py version](https://img.shields.io/pypi/pyversions/pysd.svg)](https://pypi.python.org/pypi/pysd/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5654824.svg)](https://doi.org/10.5281/zenodo.5654824)
[![JOSS](https://joss.theoj.org/papers/10.21105/joss.04329/status.svg)](https://doi.org/10.21105/joss.04329)
[![Contributions](https://img.shields.io/badge/contributions-welcome-blue.svg)](https://pysd.readthedocs.io/en/latest/development/development_index.html)
[![Docs](https://readthedocs.org/projects/pysd/badge/?version=latest)](https://pysd.readthedocs.io/en/latest/?badge=latest)

Expand Down Expand Up @@ -44,6 +44,7 @@ This approach allows SD modelers to take advantage of the most recent developmen
If you'd like to work with this repository directly, you'll need to use a recursive git checkout in order to properly load the test suite (sorry..)

The command should be something like:

```shell
git clone --recursive https://github.com/SDXorg/pysd.git
```
Expand Down
29 changes: 18 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ PySD
*Simulating System Dynamics Models in Python*

|made-with-sphinx-doc|
|DOI|
|JOSS|
|Maintained|
|PyPI license|
|conda package|
Expand Down Expand Up @@ -36,6 +36,9 @@ PySD
.. |conda package| image:: https://anaconda.org/conda-forge/pysd/badges/version.svg
:target: https://anaconda.org/conda-forge/pysd

.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.04329/status.svg
:target: https://doi.org/10.21105/joss.04329

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5654824.svg
:target: https://doi.org/10.5281/zenodo.5654824

Expand Down Expand Up @@ -91,23 +94,27 @@ If you are interested in contributing to the development of PySD, see the :doc:`

Citing
^^^^^^
If you use PySD in any published work, consider citing the `PySD Paper (2022) <https://github.com/SDXorg/pysd>`_:
If you use PySD in any published work, consider citing the `PySD Paper (2022) <https://doi.org/10.21105/joss.04329>`_:

|JOSS|

.. code-block:: latex

Martin-Martinez, E., Samsó, R., Houghton, J. P., & Solé, J. (2022). PySD: System Dynamics Modeling in Python. Journal of Open Source Software. To do
Martin-Martinez et al., (2022). PySD: System Dynamics Modeling in Python. Journal of Open Source Software, 7(78), 4329, https://doi.org/10.21105/joss.04329

.. code-block:: latex

@article{Martin-Martinez_PySD_System_Dynamics_2022,
author = {Martin-Martinez, Eneko and Samsó, Roger and Houghton, James P and Solé, Jordi},
doi = {TODO},
journal = {{Journal of Open Source Software}},
title = {{PySD: System Dynamics Modeling in Python}},
url = {https://github.com/SDXorg/pysd},
@article{Martin-Martinez2022,
doi = {10.21105/joss.04329},
url = {https://doi.org/10.21105/joss.04329},
year = {2022},
month = {6},
keywords = {System Dynamics, Vensim, XMILE, Python}
publisher = {The Open Journal},
volume = {7},
number = {78},
pages = {4329},
author = {Eneko Martin-Martinez and Roger Samsó and James Houghton and Jordi Solé},
title = {PySD: System Dynamics Modeling in Python},
journal = {Journal of Open Source Software}
}

Please, also add the `PySD Introductory Paper (2015) <https://github.com/SDXorg/pysd/blob/master/docs/PySD-Intro-Paper-Preprint.pdf>`_:
Expand Down

0 comments on commit bcfa211

Please sign in to comment.