Second iteration on J comments

This commit is contained in:
sergi-e 2020-09-20 10:53:48 +02:00 committed by Marc Garcia Puig
parent 634383f1aa
commit fb1bb8c4d7
4 changed files with 34 additions and 31 deletions

View File

@ -89,7 +89,7 @@ cd PythonAPI/examples
python3 spawn_npc.py # Support for Python2 was provided until 0.9.10 (not included)
python3 dynamic_weather.py # Support for Python2 was provided until 0.9.10 (not included)
# Optionally, to compile the PythonAPI for Python2, run the following command in the root CARLA directory.
# Optionally, to compile the PythonAPI for Python2, run the following command in the root CARLA directory
make PythonAPI ARGS="--python-version=2"
```

View File

@ -24,7 +24,7 @@ The build process can be quite long and tedious. The **[F.A.Q.](build_faq.md)**
To execute the <code>make</code> commands below, you <b>must</b> use the Visual Studio 2017 native console x64 <b>with</b> administrator rights, otherwise you may be getting permission errors.
```sh
# Make sure to meet the minimum requirements.
# Make sure to meet the minimum requirements
# Necessary software:
# CMake
@ -32,7 +32,7 @@ To execute the <code>make</code> commands below, you <b>must</b> use the Visual
# Make
# Python3 x64
# Unreal Engine 4.24
# Visual Studio 2017 with Windows 8.1 SDK and x64 Visual C++ Toolset.
# Visual Studio 2017 with Windows 8.1 SDK and x64 Visual C++ Toolset
# Set environment variables for the software

View File

@ -13,17 +13,23 @@ The ROS bridge enables two-way communication between ROS and CARLA. The informat
---
## Requirements
* __ROS Kinetic/Melodic.__ Install ROS [Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu), for Ubuntu 18.04, or [Kinetic](http://wiki.ros.org/kinetic/Installation), for Ubuntu 16.04. ROS packages may be required, depending on the user needs. [rviz](http://wiki.ros.org/rviz) to visualize ROS data.j
* __CARLA 0.9.7 or later.__ Previous versions are not compatible with the ROS bridge. Follow the [quick start installation](start_quickstart.md) or make the build for the corresponding platform.
Make sure that both requirements work properly before continuing with the installation.
!!! Important
Make sure that both CARLA and ROS work properly before continuing with the installation.
* __ROS Kinetic/Melodic.__ Install ROS [Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu), for Ubuntu 18.04, or [Kinetic](http://wiki.ros.org/kinetic/Installation), for Ubuntu 16.04. ROS packages may be required, depending on the user needs. [rviz](http://wiki.ros.org/rviz) to visualize ROS data.
* __CARLA 0.9.7 or later.__ Previous versions are not compatible with the ROS bridge. Follow the [quick start installation](start_quickstart.md) or make the build for the corresponding platform.
!!! Warning
CARLA 0.9.10 and later release packages will not be able to run the ROS bridge, as no support for Python2 is provided. Running CARLA in a build from source will be necessary.
### Python2
Those using ROS Kinetic or Melodic will need Python2 in order to run the ROS bridge. This is no problem for previous versions of CARLA. However, since 0.9.10 (included), CARLA does not provide support for Python2.
Those using ROS Kinetic or Melodic will need Python2 in order to run the ROS bridge. Release packages since 0.9.10 (included) do not provide support for Python2, so a build from source will be necessary.
In order to compile the necessary `.egg` file of the PythonAPI for Python2, run the following command in the root CARLA directory.
Make the [Linux](build_linux.md) or [Windows](build_windows.md) build from source. To compile the PythonAPI for Python2, the instructions depend on the system being used.
* __Windows__ — The PythonAPI will be built based on the installed Python version. If the system runs with Python2, the PythonAPI will be compiled properly.
* __Linux__ — Run the following command in the root CARLA directory.
```sh
make PythonAPI ARGS="--python-version=2"
@ -50,7 +56,7 @@ sudo apt-get install carla-ros-bridge # Install the latest ROS bridge version, o
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-get install carla-ros-bridge=0.9.10-1 # In this case, "0.9.10" refers to the ROS bridge version, and "1" to the Debian revision.
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 the Debian revision
```
### B. Using source repository
@ -58,7 +64,7 @@ sudo apt-get install carla-ros-bridge=0.9.10-1 # In this case, "0.9.10" refers t
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.
```sh
#setup folder structure
# Setup folder structure
mkdir -p ~/carla-ros-bridge/catkin_ws/src
cd ~/carla-ros-bridge
git clone https://github.com/carla-simulator/ros-bridge.git
@ -66,14 +72,14 @@ cd ros-bridge
git submodule update --init
cd ../catkin_ws/src
ln -s ../../ros-bridge
source /opt/ros/kinetic/setup.bash #Watch out, this sets ROS Kinetic.
source /opt/ros/kinetic/setup.bash # Watch out, this sets ROS Kinetic
cd ..
#install required ros-dependencies
# Install required ros-dependencies
rosdep update
rosdep install --from-paths src --ignore-src -r
#build
# Build
catkin_make
```

View File

@ -20,37 +20,36 @@
</summary>
```sh
# Install required modules Pygame and Numpy.
# Install required modules Pygame and Numpy
pip install --user pygame numpy
# There are two different ways to install CARLA.
# There are two different ways to install CARLA
# Option A) Debian 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.
# 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 # 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.
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
./CarlaUE4.sh
# 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`.
# Download the desired package and additional assets
# Extract the package
# 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.
cd PythonAPI/examples
python3 spawn_npc.py # Support for Python2 was provided until 0.9.10 (not included)
# Optionally, to compile the PythonAPI for Python2, run the following command in the root CARLA directory.
make PythonAPI ARGS="--python-version=2"
# The PythonAPI can be compiled for Python2 when using a Linux build from source
```
</details>
@ -92,7 +91,7 @@ cd /opt/carla-simulator # Open the folder where CARLA is installed
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 the Debian revision.
sudo apt-get install carla-simulator=0.9.10-1 # In this case, "0.9.10" refers to a CARLA version, and "1" to the Debian revision
```
!!! Important
@ -152,11 +151,9 @@ Now it is time to start running scripts. The following example will spawn some l
> python3 spawn_npc.py # Support for Python2 was provided until 0.9.10 (not included)
```
Optionally, to compile the PythonAPI for Python2, run the following command in the root CARLA directory.
!!! Note
The PythonAPI can be compiled for Python2 when using a [Linux build from source](build_linux.md).
```sh
make PythonAPI ARGS="--python-version=2"
```
#### Command-line options
@ -178,7 +175,7 @@ The script `PythonAPI/util/config.py` provides for more configuration options.
> ./config.py --map Town05 # Change map
> ./config.py --weather ClearNoon # Change weather
> ./config.py --help # Check all the available configuration options.
> ./config.py --help # Check all the available configuration options
```
---