Skip to content

Checking Out Platform Code

When you begin working on a new computer or robot, you will need to check out the platform code.

Project Organization

The platform code is open source and is available in the github.com/ut-av organization on GitHub. The repository is structured as follows:

roboracer_ws/
├── ...
├── scripts
├── src
├── ...

Note that each ROS2 package has its git own repository in the src directory.

There are 2 steps to acquire the code:

  1. Clone the roboracer_ws repository.
  2. Checkout the code using the ./scripts/checkout.sh script.

Cloning the Repositories

SSH into the machine (car or lab computer), then clone the roboracer_ws repository into your home directory:

cd ~
git clone https://github.com/ut-av/roboracer_ws.git

Change directory to the ~/roboracer_ws directory that was just checked out, then run the checkout script:

cd ~/roboracer_ws
./scripts/checkout.sh

Note: the checkout script is idempotent, meaning it can be run multiple times without any negative effects.

Updating the Code

Occasionally, you may need to update the code to the latest version.

This should be done in 3 steps after SSHing into the machine (car or lab computer):

  1. Run git pull to update the roboracer_ws repository.

  2. Run ./scripts/checkout.sh to update all of the repositories in the src folder.

  3. Rebuild the container if necessary using the ./container build command.

cd ~/roboracer_ws
git pull
./scripts/checkout.sh