ROS2swarm Documentation
=======================

.. toctree::
   :maxdepth: 1
   :hidden: 
   
   installation.rst
   architecture.rst  
   patterns.rst
   robots.rst 
   sensors.rst 
   howto.rst 
   contact.rst

ROS2swarm is a ROS 2 package providing a framework for and library of swarm behaviors.
Its aim is to facilitate swarm robotic projects in research, education, and industry. 

The ROS2swarm package can be found on `Github <https://github.com/ROS2swarm/ROS2swarm>`_ and is currently available for the ROS 2 versions:

* `Dashing <https://github.com/ROS2swarm/ROS2swarm/tree/dashing-dev>`_, 
* `Foxy <https://github.com/ROS2swarm/ROS2swarm/tree/foxy-dev>`_, and 
* `Galatic <https://github.com/ROS2swarm/ROS2swarm/tree/galactic-dev>`_.

This site contains the documentation for ROS2swarm. 
If you use ROS2swarm in your work, please cite the 2022 ICRA paper `ROS2SWARM - A ROS 2 Package for Swarm Robot Behaviors <http://heikohamann.de/pub/kaiserICRA2022.pdf>`_.

T. K. Kaiser, M. J. Begemann, T. Plattenteich, L. Schilling, G. Schildbach and H. Hamann, "ROS2SWARM - A ROS 2 Package for Swarm Robot Behaviors," 2022 International Conference on Robotics and Automation (ICRA), Philadelphia, PA, USA, 2022, pp. 6875-6881, doi: 10.1109/ICRA46639.2022.9812417.

.. code-block::

	@INPROCEEDINGS{9812417,
		author={Kaiser, Tanja Katharina and Begemann, Marian Johannes and Plattenteich, Tavia and Schilling, Lars and Schildbach, Georg and Hamann, Heiko},
		booktitle={2022 International Conference on Robotics and Automation (ICRA)}, 
  		title={ROS2SWARM - A ROS 2 Package for Swarm Robot Behaviors}, 
  		year={2022},
  		volume={},
  		number={},
  		pages={6875-6881},
  		doi={10.1109/ICRA46639.2022.9812417}
  	}


Getting started
---------------

* :doc:`Installation <installation>`

  - Instructions to set up ROS2swarm 
  
* :doc:`Swarm Behaviors <patterns>`

  - Overview of implemented swarm behaviors 

* :doc:`Supported Robot Platforms <robots>`

  - Overview of currently supported robot platforms 

* :doc:`Sensor Layer <sensors>`

  - Overview of currently supported sensor types  

* :doc:`How-to Guides <howto>`

  - Guides for using ROS2swarm  
  
* :doc:`Contact <contact>`

  - Contact details for questions or contributions