Skip to content

Commit

Permalink
Add Zenodo DOI badge
Browse files Browse the repository at this point in the history
This commit adds a digital object identifier (DOI) so that
the library can now be cited when used in papers or other
things.

Author: ljvmiranda921
Email: ljvmiranda@gmail.com
  • Loading branch information
ljvmiranda921 committed Sep 24, 2017
1 parent a95b7f0 commit 400e47b
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
:target: https://raw.githubusercontent.com/ljvmiranda921/pyswarms/master/LICENSE
:alt: License

.. image:: https://zenodo.org/badge/97002861.svg
:target: https://zenodo.org/badge/latestdoi/97002861
:alt: Citation

PySwarms is a an extensible research toolkit for particle swarm optimization (PSO) in Python.

* Free software: MIT license
Expand Down Expand Up @@ -119,6 +123,20 @@ The package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypacka
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

Cite us
--------
Are you using PySwarms in your project or research? Please cite us!

.. code-block:: bibtex
@article{PySwarms2017,
author = "Lester James V. Miranda",
year = 2017,
title = "PySwarms, a research-toolkit for Particle Swarm Optimization in Python",
doi = {10.5281/zenodo.986300},
url = {https://zenodo.org/badge/latestdoi/97002861}
}
Others
------
Like it? Love it? Leave us a star on Github_ to show your appreciation!
Expand Down
4 changes: 4 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Welcome to PySwarms's documentation!
:target: https://raw.githubusercontent.com/ljvmiranda921/pyswarms/master/LICENSE
:alt: License

.. image:: https://zenodo.org/badge/97002861.svg
:target: https://zenodo.org/badge/latestdoi/97002861
:alt: Citation

PySwarms is a an extensible research toolkit for particle swarm optimization (PSO) in Python.

* Free software: MIT license
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.1.5
current_version = 0.1.6
commit = True
tag = True

Expand Down

0 comments on commit 400e47b

Please sign in to comment.