The purpose of this page is to get new CS developers up and going for robosub. If you have any questions, feel free to ask them on the software slack channel!
The sub itself runs Ubuntu 20.04 (focal), as do most members. Any operating system which can run ROS2 foxy should work such as Linux Mint 20. Windows is currently not supported.
If you don't feel comfortable installing linux on your machine yet, you can get started with a virtual machine. To do so you can install virtualization software such as virtualBox.
We use C++ and Python3 for the software on the sub. Below are a few links for tutorials for these languages, these are just a few I quickly found to get you started, feel free to search around for other tutorials.
This will setup your computer with ROS package repository and other dependencies. If you experience any issues, please contact the IT slack channel. Depending on your operating system, follow the instructions on one of these pages:
ROS2 Foxy (for Ubuntu 20.04 focal or Linux Mint 20)
Complete prerequisite software setup as follows:
Add ROS2 setup script to bash configuration file and reload it.
$ echo "source /opt/ros/foxy/setup.bash" >> ~/.bashrc $ source ~/.bashrc
Install additional apt packages needed by our code.
$ sudo apt update $ sudo apt install git python3-rosdep2 python3-colcon-common-extensions ros-foxy-gazebo-ros ros-foxy-gazebo-plugins socat
SSH keys allow you to upload code to gitlab without entering a password. This makes development more convenient but less secure since someone else could use your key if they get access to your computer. Follow these steps if you want to setup ssh keys on your computer. You only need to do this once on each computer. To check if you already have keys made for your computer, run:
$ ls ~/.ssh/id_rsa*
If you don't see id_rsa and id_rsa.pub files, you can create new keys by running:
$ ssh-keygen
Just hit enter through all of the prompts. Don't type in a password, the entire point of this is to eliminate the need to use a password with gitlab! Now, copy the contents of id_rsa.pub and paste the contents in a new key here. To test if this worked, run:
$ ssh git@gitlab.com
If everything is set up correctly, you should expect to see a message like:
PTY allocation request failed on channel 0 Welcome to GitLab, @user! Connection to gitlab.com closed.
Finally, we need to setup our ROS workspace with the robosub code.
Create a directory for robosub code and move into it.
$ mkdir -p ~/ros/src $ cd ~/ros/src
Clone essential robosub repositories. Note that here we clone using https. If you setup ssh keys than you should clone using ssh instead. Replace the https://gitlab.com/ parts of the links below with git@gitlab.com: to clone with ssh.
$ git clone https://gitlab.com/PalouseRobosub/Software/robosub.git $ git clone https://gitlab.com/PalouseRobosub/Software/robosub_msgs.git $ git clone https://gitlab.com/PalouseRobosub/Software/robosub_simulator.git
Move back to the ros directory.
$ cd ~/ros
Compile the code for the first time. This will take some time since it has to compile a lot of code. Future compilation should be much faster since the build system will know what it has already compiled.
$ colcon build
Add compiled code configuration to bash configuration file.
$ echo "source ~/ros/install/setup.bash" >> ~/.bashrc
Add rsmake alias to bash configuration file so future compilation can be run easily.
$ echo 'alias rsmake="(cd ~/ros && colcon build)"' >> ~/.bashrc
Reload bash configuration file.
$ source ~/.bashrc
From now on you should be able to compile code using rsmake from any directory.
If you were able to successfully compile the software at the end, congrats! Next steps are to learn how to use git and review c++ and python3. After this, head over to the gitlab issues page and see if a task looks interesting!