User Manual - TomHulme/306-Swarm-Robotics-Project GitHub Wiki

Install Instructions

This page contains information on how to install and run the ROSClub7 SE306 Robotic Swarm Project.

Software Requirements

  • ROS
  • Player/Stage
  • Python2.7/3.x (BOTH VERSIONS!)
  • A machine running Linux
  • gtest (For running tests)

Cloning from github

Running the following line of code will clone our repository into a local directory on your computer! $ git clone https://github.com/TomHulme/306-Swarm-Robotics-Project.git

This may take a while, as you will need to download the entire contents of our repository! Don't worry though, its all necessary!

Locating the folder

With the last command will have cloned the repository into a local sub-directory on your PC named "306-Swarm-Robotics-Project". We need to enter this directory using the following command:

$ cd 306-Swarm-Robotics-Project/

Running the project

Lastly, to run the project, all you need to do is run our simple Python Automation script!

$ python automateprojectscript.py

Running Tests

To run tests, you need to make sure the project if first compiled. Run:

$ rosmake se306Project

Once the project has been built, make sure you are in the 306-Swarm-Robotics-Project/se306Project/ folder. If you're still in 306-Swarm-Robotics-Project, use this command to enter the correct directory:

$ cd se306Project

Once in this directory, run a command to make the tests:

$ make test

This should build and run the tests! Note: You will need gtest installed to run the tests.