Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsonandrade committed Sep 26, 2023
1 parent 5fa6757 commit 191f9f6
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![Documentation Status](https://readthedocs.org/projects/pyswarming/badge/?version=latest)](https://pyswarming.readthedocs.io/en/latest/?badge=latest)
![version](https://img.shields.io/badge/version-1.1.3-blue)
[![Downloads](https://static.pepy.tech/personalized-badge/pyswarming?period=total&units=none&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/pyswarming)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05647/status.svg)](https://doi.org/10.21105/joss.05647)

<img align="left" src="docs/readme_pics/logo.png">

Expand Down Expand Up @@ -77,6 +78,25 @@ This library includes the following algorithms to be used in swarm robotics:

[^11]: B. M. Zoss et al., “Distributed system of autonomous buoys for scalable deployment and monitoring of large waterbodies,” Auton. Robots, vol. 42, no. 8, pp. 1669–1689, Dec. 2018. https://doi.org/10.1007/s10514-018-9702-0.

## Citing PySwarming

If you make use of PySwarming for your research, please cite our [JOSS publication](https://joss.theoj.org/papers/10.21105/joss.05647/status.svg). Here is the corresponding BibTeX entry:

```
@article{de Andrade2023,
doi = {10.21105/joss.05647},
url = {https://doi.org/10.21105/joss.05647},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {89},
pages = {5647},
author = {Emerson Martins de Andrade and Antonio Carlos Fernandes and Joel Sena Sales},
title = {PySwarming: a research toolkit for Swarm Robotics},
journal = {Journal of Open Source Software}
}
```

## Examples using pyswarming.swarm
```python
# importing the swarm creator
Expand Down Expand Up @@ -249,7 +269,6 @@ for submitting a PR (Pull Request).

If you have any ideas or questions, feel free to open an issue.


## Acknowledgements
The authors would like to thank the Human Resources Program from the National Agency of Oil, Gas and Bio Combustibles – PRH-ANP for the financial support.
This work was supported by "Coordenação de Aperfeiçoamento de Pessoal de Nível Superior - Brasil (CAPES)", [LOC/COPPE/UFRJ](https://www.loc.ufrj.br/index.php/en/) ([Laboratory of Waves and Current](https://www.loc.ufrj.br/index.php/en/) - [Federal University of Rio de Janeiro](https://ufrj.br/en/)) and the National Council for Scientific and Technological Development (CNPq), which are gratefully acknowledged.

0 comments on commit 191f9f6

Please sign in to comment.