diff --git a/README.md b/README.md index c21a40e2..b2d93de7 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ PySD [![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) [![Docs](https://readthedocs.org/projects/pysd/badge/?version=latest)](https://pysd.readthedocs.io/en/latest/?badge=latest) @@ -33,6 +34,10 @@ If you use PySD in any published work, consider citing the [PySD Introductory Pa >Houghton, James; Siegel, Michael. "Advanced data analytics for system dynamics models using PySD." *Proceedings of the 33rd International Conference of the System Dynamics Society.* 2015. +You can also cite the library using the [DOI provided by Zenodo](https://zenodo.org/search?page=1&size=20&q=pysd). It is recomendable to specify the used PySD version and its correspondent DOI. If you want to cite all versions you can use the generic DOI for PySD instead: + +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5654824.svg)](https://doi.org/10.5281/zenodo.5654824) + ### Why create a new SD simulation engine? diff --git a/docs/index.rst b/docs/index.rst index 4c9ec649..1e4b1c21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,6 +2,38 @@ PySD ==== *Simulating System Dynamics Models in Python* +|made-with-sphinx-doc| +|DOI| +|PyPI license| +|conda package| +|PyPI package| +|PyPI status| +|PyPI pyversions| + +.. |made-with-sphinx-doc| image:: https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg + :target: https://www.sphinx-doc.org/ + +.. |docs| image:: https://readthedocs.org/projects/pysd/badge/?version=latest + :target: https://pysd.readthedocs.io/en/latest/?badge=latest + +.. |PyPI license| image:: https://img.shields.io/pypi/l/sdqc.svg + :target: https://github.com/JamesPHoughton/pysd/blob/master/LICENSE + +.. |PyPI package| image:: https://badge.fury.io/py/pysd.svg + :target: https://badge.fury.io/py/pysd + +.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/pysd.svg + :target: https://pypi.python.org/pypi/pysd/ + +.. |PyPI status| image:: https://img.shields.io/pypi/status/pysd.svg + :target: https://pypi.python.org/pypi/pysd/ + +.. |conda package| image:: https://anaconda.org/conda-forge/pysd/badges/version.svg + :target: https://anaconda.org/conda-forge/pysd + +.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5654824.svg + :target: https://doi.org/10.5281/zenodo.5654824 + This project is a simple library for running System Dynamics models in python, with the purpose of improving integration of Big Data and Machine Learning into the SD workflow. @@ -46,14 +78,17 @@ If you find a bug, or are interested in a particular feature, see :doc:`reportin If you are interested in contributing to the development of PySD, see the :doc:`developer documentation <../development/development_index>` listed above. -Support -^^^^^^^ -For additional help or consulting, contact james.p.houghton@gmail.com +Citing +^^^^^^ +If you use PySD in any published work, consider citing the `PySD Introductory Paper `_:: + Houghton, James; Siegel, Michael. "Advanced data analytics for system dynamics models using PySD." *Proceedings of the 33rd International Conference of the System Dynamics Society.* 2015. -Indices and tables -================== +You can also cite the library using the `DOI provided by Zenodo `_. It is recomendable to specify the used PySD version and its correspondent DOI. If you want to cite all versions you can use the generic DOI for PySD instead: -* :ref:`genindex` +|DOI| +Support +^^^^^^^ +For additional help or consulting, contact james.p.houghton@gmail.com or eneko.martin.martinez@gmail.com.