vrx_2023 validation

How to validate your submission

This tutorial will allow you to check that your submission for phase 2 or 3 complies with the VRX competition requirements.

Prerequisites

We assume you have already installed VRX and prepared a submission that you want to validate. This means:

• You have created a Docker image containing your solution to one or more tasks and uploaded it to Docker hub.
• You have created the required files for a phase 2 or phase 3 submission.

Step 1: Get ready to validate

1. Change into the vrx_ws/src directory you created when installing vrx.

   cd ~/vrx_ws/src

2. Clone the vrx-docker repository.

   git clone https://github.com/osrf/vrx-docker

   This should create a new vrx-docker directory alongside the original vrx repository directory.

3. Source your bash.setup file, change into the vrx-docker directory, and set the variable TEAM for later use:

   source ~/vrx_ws/devel/setup.bash
   cd vrx-docker
   TEAM=<your_team_name>

   Replace <your_team_name> with the team name you will use for your submission.

4. Create a new folder called <your_team_name> in the vrx-docker/team_config folder.

   mkdir team_config/$TEAM
   

5. Copy your submission files (yaml config files and docker hub image name) to the vrx-docker/team_config/<your_team_name> folder.

Step 2: Verify your dockerhub_image.txt file.

To test that your dockerhub_image.txt file contains the name of a reachable docker image (and version), run:

#!bash
    
cat "team_config/$TEAM/dockerhub_image.txt" | xargs docker pull

If the contents of the file are correct, docker should begin to pull your image. Once you have verified this is working, you can exit out of the pull using ctrl+c.

Step 3: Check propulsion and sensor compliance.

1. Run the prepare_team_wamv.bash script included with vrx-docker to set up your team's wamv configuration:

   ./prepare_team_wamv.bash "$TEAM"

   Note that this will produce a REQUIRED process [wamv_config/wamv_generator-2] has died! message, which is expected.

2. Check compliance:

   cat "generated/team_generated/$TEAM/compliant.txt"

   The output of the above should be true if your configuration passes compliance tests.