Skip to content

Commit

Permalink
Issue #3: Updates README
Browse files Browse the repository at this point in the history
- Updates the README to remove the instructions for needing the uav_game repo, as this code is no longer used in the AV stack.
- Adds an overview section.
- Modifies some instructions for clarity.
- Adds information about the Michigan server instructions.
  • Loading branch information
exoticDFT committed Nov 19, 2020
1 parent 1a107d5 commit 3ed6c63
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# carla_circle
# Stanford MSL (Carla) AV Stack

Workspace for ROS and scripts to work with Carla MCity Event 1.
## Overview

## carla version / carla ros version
This repository provides the MSL's AV Stack that works with the Carla Simulator.
The instructions below explain how to setup a Catkin workspace for ROS. At the
moment, this stack is designed for the Carla MCity Event 1.

For this challenge we use a special MCity binaries provided by Michigan. The
binaries use Carla version 0.9.9.4 and have a special map designed for the
challenges.
[comment]: <> (
TODO: Add details about the high and low level architecture of the AV stack
)

## Carla Version / Carla ROS Version

For this challenge we use special MCity binaries provided by Univ. of Michigan.
The binaries use Carla version 0.9.9.4 and have a special map designed for the
challenges.

## Setup your Catkin workspace
## Setup the Catkin Workspace

Start by creating a new catkin workspace directory. Something like

Expand All @@ -31,26 +38,28 @@ git submodule update --init
cd ../
rosdep update
rosdep install --from-paths src --ignore-src -r
cd ~/Catkin_Workspace/tri-carla-challenges/src
git clone [email protected]:StanfordMSL/uav_game.git -b carla
```

Then we need to compile our Catkin workspace.

**The first time you run this you do not need to run the command
`catkin clean --yes`. If you do run the command, you will get an error, which
`catkin clean --yes`. If you do run the command, you will get an error, but this
can be ignored.**

```bash
cd ~/Catkin_Workspace/tri-carla-challenges
catkin clean --yes
export GUROBI_HOME=/opt/gurobi811/linux64
catkin build uavgame
catkin build carla_ackermann_control carla_circle carla_ego_vehicle carla_infrastructure carla_manual_control carla_msgs carla_ros_bridge carla_waypoint_publisher
catkin build rqt_carla_control
```

## Run the AV client
## Running the AV Client

***Note:**
We assume an instance of Carla is running and available on the localhost. By
default, running `./CarlaUE4.sh` from the Carla simulator directory should be
efficient. However, if running on Michigan's server, you should follow the
instructions found [here](https://yyab.github.io/mcityCarlaChallenge.io/).*

We should now be able to run the AV client on the server. In a terminal enter
the following:
Expand Down

0 comments on commit 3ed6c63

Please sign in to comment.