From 29cb90f8aa17fa083bc4ec8dc95cb4b6a6ff588c Mon Sep 17 00:00:00 2001 From: sergi-e Date: Tue, 1 Sep 2020 10:27:17 +0200 Subject: [PATCH] First draft --- Docs/ros_installation.md | 33 ++++++++++---------- Docs/start_quickstart.md | 66 +++++++++++++++++++--------------------- 2 files changed, 48 insertions(+), 51 deletions(-) diff --git a/Docs/ros_installation.md b/Docs/ros_installation.md index d52e43a3a..116004cff 100644 --- a/Docs/ros_installation.md +++ b/Docs/ros_installation.md @@ -2,8 +2,8 @@ * [__Requirements__](#requirements) * [__Bridge installation__](#bridge-installation) - * a) using apt repository - * b) using source repository + * [A. Using deb repository](#a-using-deb-repository) + * [B. Using source repository](#b-using-source-repository) * [__Run the ROS bridge__](#run-the-ros-bridge) * [__Setting CARLA__](#setting-carla) @@ -22,29 +22,28 @@ The ROS bridge enables two-way communication between ROS and CARLA. The informat --- ## Bridge installation -### a) Using apt repository +### A. Using deb repository -Add the apt repository. - -* __Bridge for ROS Melodic.__ +Set up the deb repository in the system. ```sh -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 81061A1A042F527D && -sudo add-apt-repository "deb [arch=amd64 trusted=yes] http://dist.carla.org/carla-ros-bridge-melodic/ bionic main" +sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1AF1527DE64CB8D9 +sudo add-apt-repository "deb [arch=amd64] http://dist.carla.org/carla $(lsb_release -sc) main" +``` +Install CARLA and check for the installation in the `/opt/` folder. +```sh +sudo apt-get update # Update the repository +sudo apt-get install carla-ros-bridge # Install the latest ROS bridge version, or update the current installation ``` -* __Bridge for ROS Kinetic.__ +This repository contains features from CARLA 0.9.10 and later versions. To install a specific version add the version tag to the installation command. ```sh -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 9BE2A0CDC0161D6C && -sudo add-apt-repository "deb [arch=amd64 trusted=yes] http://dist.carla.org/carla-ros-bridge-kinetic xenial main" +sudo apt-get install carla-ros-bridge==0.9.10-1 # In this case, "0.9.10" refers to the ROS bridge version, and "-1" to a deb tag, which usually will always be the same. ``` -Install the ROS bridge. -```sh -sudo apt update && -sudo apt install carla-ros-bridge- -``` +!!! Important + To install ROS bridge versions prior to 0.9.10, change to a previous version of the documentation using the pannel in the bottom right corner of the window, and follow the old instructions. -### b) Using source repository +### B. Using source repository A catkin workspace is needed to use the ROS bridge. It should be cloned and built in there. The following code creates a new workspace, and clones the repository in there. diff --git a/Docs/start_quickstart.md b/Docs/start_quickstart.md index 1c2d86bf9..feb8daea5 100644 --- a/Docs/start_quickstart.md +++ b/Docs/start_quickstart.md @@ -3,11 +3,11 @@ * __[Installation summary](#installation-summary)__ * __[Requirements](#requirements)__ * __[CARLA installation](#carla-installation)__ - * a) deb CARLA installation - * b) GitHub repository installation + * [A. deb CARLA installation](#a-deb-carla-installation) + * [B. Package installation](#b-package-installation) * __[Import additional assets](#import-additional-assets)__ * __[Running CARLA](#running-carla)__ - * Command-line options + * [Command-line options](#command-line-options) * __[Updating CARLA](#updating-carla)__ * __[Follow-up](#follow-up)__ @@ -23,39 +23,29 @@ # Install required modules Pygame and Numpy. pip install --user pygame numpy -# Option A) deb package installation of CARLA 0.9.9 (only Linux) -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 92635A407F7A020C -sudo add-apt-repository "deb [arch=amd64 trusted=yes] http://dist.carla.org/carla-0.9.9/ all main" +# There are two different ways to install CARLA. + +# Option A) deb package installation +# This repository contains CARLA 0.9.10 and later. To install previous CARLA versions, change to a previous version of the docs using the pannel in the bottom right part of the window. +sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1AF1527DE64CB8D9 +sudo add-apt-repository "deb [arch=amd64] http://dist.carla.org/carla $(lsb_release -sc) main" sudo apt-get update -sudo apt-get install carla-simulator -cd /opt/carla-simulator/bin -./CarlaUE4.sh -# To install CARLA 0.9.8 instead -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 304F9BC29914A77D && -sudo add-apt-repository "deb [arch=amd64 trusted=yes] http://dist.carla.org/carla-0.9.8/ all main" -sudo apt-get update -sudo apt-get install carla-simulator -cd /opt/carla-simulator/bin -./CarlaUE4.sh -# To install CARLA 0.9.7 instead -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys DB53A429E64554FC && -sudo add-apt-repository "deb [arch=amd64 trusted=yes] http://dist.carla.org/carla-0.9.7/ all main" -sudo apt-get update -sudo apt-get install carla-simulator +sudo apt-get install carla-simulator # Install the latest CARLA version or update the current installation. +sudo apt-get install carla-simulator==0.9.10-1 # install a specific CARLA version. cd /opt/carla-simulator/bin ./CarlaUE4.sh -# Option B) GitHub repository installation +# Option B) Package installation # Go to: https://github.com/carla-simulator/carla/blob/master/Docs/download.md # Download the desired package and additional assets. # Extract the package. -# Extract the additional assets in `/Import` -# Run CARLA (Linux) +# Extract the additional assets in `/Import`. +# Run CARLA (Linux). ./CarlaUE.sh -# Run CARLA (Windows) +# Run CARLA (Windows). > CarlaUE4.exe -# Run a script to test CARLA +# Run a script to test CARLA. cd PythonAPI/examples python3 spawn_npc.py @@ -83,21 +73,29 @@ To install both modules using [pip](https://pip.pypa.io/en/stable/installing/), The __deb installation__ is the easiest way to get the latest release in Linux. __Download the GitHub repository__ to get either a specific release or the Windows version of CARLA. -### a) deb CARLA installation +### A. deb CARLA installation -Add the CARLA 0.9.9 repository to the system. +Set up the deb repository in the system. ```sh -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 92635A407F7A020C -sudo add-apt-repository "deb [arch=amd64 trusted=yes] http://dist.carla.org/carla-0.9.9/ all main" +sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1AF1527DE64CB8D9 +sudo add-apt-repository "deb [arch=amd64] http://dist.carla.org/carla $(lsb_release -sc) main" ``` Install CARLA and check for the installation in the `/opt/` folder. ```sh -sudo apt-get update -sudo apt-get install carla-simulator -cd /opt/carla-simulator +sudo apt-get update # Update the repository +sudo apt-get install carla-simulator # Install the latest CARLA version, or update the current installation +cd /opt/carla-simulator # Open the folder where CARLA is installed ``` -### b) Package installation +This repository contains CARLA 0.9.10 and later versions. To install a specific version add the version tag to the installation command. +```sh +sudo apt-get install carla-simulator==0.9.10-1 # In this case, "0.9.10" refers to a CARLA version, and "-1" to a deb tag, which usually will always be the same. +``` + +!!! Important + To install CARLA versions prior to 0.9.10, change to a previous version of the documentation using the pannel in the bottom right corner of the window, and follow the old instructions. + +### B. Package installation