Skip to content

WPI-NASA-SRC-P2/capricorn_competition_round

Repository files navigation

Google sheet link for all the links to important stuff. Feel free to add new links if you find any.

Working with the simulation

Setup Simulation

Downloading the simulation:

Clone the repository if you haven't done it already. (Enter your GitHub credentials when prompted)

cd && git clone https://github.com/WPI-NASA-SRC-P2/srcp2-final-public.git

Please read the wiki to install the sim.

Setting the aliases for easing the usage:

Add the sourcing line to the bashrc by executing this command:

echo "source ~/srcp2-final-public/aliases.bash" >> ~/.bashrc

Starting and stopping the Simulation

With the aliases set above, simulation should start with a command src_start_simulation, and can be killed with a command src_stop_simulation

(For the first time, you might have to execute source ~/.bashrc or use a new terminal)

Terminal

To attach a terminal to the simulation docker, execute src_sim_terminal

(You won't usually need this access, but the alias has been set nonetheless)

Developing and Testing

Download the repository

Create a workspace and clone the repository

mkdir -p ~/catkin_ws/src 
cd ~/catkin_ws/src/ && git clone https://github.com/WPI-NASA-SRC-P2/capricorn_competition_round.git

Setup Visual Studio Code

Install and setup Visual Studio Code for developing with CPP with the instructions given here

Install the following extensions for VSCode

  1. Docker
  2. Remote-containers

Developing with VSC

  1. Start the development container
src_start_comp_docker

Click on Docker extension, right click on the running container from previous step and click Attach Visual Studio Code

For executing any command within the development container, use the VScode terminal. This terminal will be running within the development container. You can open this terminal by pressing: ctrl +` (ctrl + tilde key)

For getting the command line access to the docker, execute src_comp_terminal