<commit_before># swarm_robot_ros_sim
A swarm robot simulation environment for ROS to be used with Gazebo.

## Motivation
This project starts after investigating several swarm robot platforms like Kilobot, E-puck, Jasmine, Alice, etc, and working on a novel swarm microrobot called [Inchbot](http://www.case.edu/mae/robotics/#modular) for a while. It would be interesting to see what these swarm microrobots can do as a collective under simulation environment like ROS. This simulation aims to be a general swarm robots simulation platform.

Current research topic is decentrized formation control.

## What's inside
*swarm_robot_ros_sim* contains packages each of which features a set of functionalities for this simulation platform:

*swarm_robot_description* package describes the robot models and simulation environment initialization files.

*swarm_robot_msgs* folder contains packages for customized messages, services and actions that will be used in other packages.

*swarm_robot_controller* package contains the low level controllers for the swarm robots.

*swarm_robot_simulation* package contains the swarm algorithms.

## Setup
Have ROS Indigo installed and workspace setup. Clone this package in ~/ros_ws/src and build with catkin_make.

## Demo
Two wheel robot dispersion simulation:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`roslaunch swarm_robot_description two_wheel_robot.launch robot_quantity:=20 half_range:=0.5`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_simulation two_wheel_robot_dispersion _spring_length:=0.7 _sensing_range:=2.0`

Two wheel robot aggregation simulation:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`roslaunch swarm_robot_description two_wheel_robot.launch robot_quantity:=30 half_range:=2.0`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_simulation two_wheel_robot_aggregation _sensing_range:=1.5`

Two wheel robot line formation simulation:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`roslaunch swarm_robot_description two_wheel_robot.launch robot_quantity:=25 half_range:=0.7`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_simulation two_wheel_robot_line_formation _spring_length:=0.7 _sensing_range:=2.0`

Optionally, in all previous tests, robots can be added or deleted through:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_description two_wheel_robot_batch_add _robot_quantity:=10 _half_range:=1.0`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosservice call /swarm_sim/two_wheel_robot_update (press tab)...`

## Why not ROS Stage
Some swarm robot research model the robot as a dot, like ROS Stage. In my idea, there is distinct difference between random move of dot and omnidirectional move of complete robot model. Here we use full model of the real robots to bridge the gap between simulation and implementation. Although it has drawback that the simulation speed goes low when more than 100 of such complex robot models are in Gazebo, we will try to overcome that.

## Contribution

## License
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).
<commit_msg>update format<commit_after># swarm_robot_ros_sim
A swarm robot simulation environment for ROS to be used with Gazebo.

## Motivation
This project starts after investigating several swarm robot platforms like Kilobot, E-puck, Jasmine, Alice, etc, and working on a novel swarm microrobot called [Inchbot](http://www.case.edu/mae/robotics/#modular) for a while. It would be interesting to see what these swarm microrobots can do as a collective under simulation environment like ROS. This simulation aims to be a general swarm robots simulation platform.

Current research topic is decentrized formation control.

## What's inside
*swarm_robot_ros_sim* contains packages each of which features a set of functionalities for this simulation platform:

*swarm_robot_description* package describes the robot models and simulation environment initialization files.

*swarm_robot_msgs* folder contains packages for customized messages, services and actions that will be used in other packages.

*swarm_robot_controller* package contains the low level controllers for the swarm robots.

*swarm_robot_simulation* package contains the swarm algorithms.

## Setup
Have ROS Indigo installed and workspace setup. Clone this package in ~/ros_ws/src and build with catkin_make.

## Demo
Two wheel robot dispersion simulation:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`roslaunch swarm_robot_description two_wheel_robot.launch robot_quantity:=20 half_range:=0.5`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_simulation two_wheel_robot_dispersion _spring_length:=0.7 _sensing_range:=2.0`

Two wheel robot aggregation simulation:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`roslaunch swarm_robot_description two_wheel_robot.launch robot_quantity:=30 half_range:=2.0`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_simulation two_wheel_robot_aggregation _sensing_range:=1.5`

Two wheel robot line formation simulation:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`roslaunch swarm_robot_description two_wheel_robot.launch robot_quantity:=25 half_range:=0.7`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_simulation two_wheel_robot_line_formation _spring_length:=0.7 _sensing_range:=2.0`

Optionally, in all previous tests, robots can be added or deleted through:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosrun swarm_robot_description two_wheel_robot_batch_add _robot_quantity:=10 _half_range:=1.0`

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`rosservice call /swarm_sim/two_wheel_robot_update (press tab)...`

## Why not ROS Stage
Some swarm robot research model the robot as a dot, like ROS Stage. In my idea, there is distinct difference between omnidirectional move of dot robot and complete robot model. Here we use full model of the real robots to bridge the gap between simulation and implementation. Although it has drawback that the simulation speed goes low when more than 100 of such complex robots are in Gazebo, we will try to overcome that.

## Contribution

## License
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).

{'fraction_non_alphanumeric': 0.07930525970834017, 'fraction_numerical': 0.00950352285761101, 'mean_word_length': 6.756035578144854, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2291406', 'n_tokens_mistral': 1850, 'n_tokens_neox': 1706, 'n_words': 638}