Skip to content
This repository was archived by the owner on Jul 16, 2025. It is now read-only.

Commit 6a57579

Browse files
authored
Documentation update with apt installation instructions (#220)
1 parent 4441c1c commit 6a57579

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

docs/setup.rst

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,60 @@
22
Setup
33
=====
44

5-
Installation from source as ROS 2 workspace
6-
-------------------------------------------
5+
Installation with ROS 2
6+
-----------------------
77

88
Prerequisites
99
^^^^^^^^^^^^^
1010

11-
Install ROS2 humble following the `installation instructions <https://docs.ros.org/en/humble/Installation.html>`_.
11+
Install ROS2 following the `installation instructions <https://docs.ros.org/en/jazzy/Installation.html>`_ for your distribution `$ROS_DISTRO`.
1212

13-
Installation
14-
^^^^^^^^^^^^^
13+
Scenario execution currently supports the ROS 2 distributions `Humble <https://docs.ros.org/en/humble/index.html>`_ and `Jazzy <https://docs.ros.org/en/jazzy/index.html>`_.
1514

16-
Clone the scenario execution repository
15+
Installation as Debian package (recommended)
16+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
17+
18+
To install scenario execution together with all its libraries, run
1719

1820
.. code-block:: bash
1921
20-
git clone https://github.com/IntelLabs/scenario_execution.git
22+
sudo apt update && sudo apt install -y ros-$ROS_DISTRO-scenario_execution*
23+
24+
To install just the core packages of scenario execution, run
25+
26+
.. code-block:: bash
27+
28+
sudo apt update && sudo apt install -y ros-$ROS_DISTRO-scenario_execution ros-$ROS_DISTRO-scenario_execution_ros ros-$ROS_DISTRO-scenario_execution_rviz
2129
22-
and update its submodules by running the following command in the root folder of the cloned repository
30+
31+
Developer Installation (from source as ROS 2 workspace)
32+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
34+
Clone the scenario execution repository
2335

2436
.. code-block:: bash
2537
26-
git submodule update --init
38+
git clone https://github.com/IntelLabs/scenario_execution.git
2739
28-
install the necessary dependencies
40+
and install the necessary dependencies
2941

3042
.. code-block:: bash
3143
3244
rosdep install --from-paths . --ignore-src
3345
pip3 install -r requirements.txt
3446
35-
and build it
47+
Now, build your workspace by running
3648

3749
.. code-block:: bash
3850
3951
colcon build
4052
53+
and source your installation by running
54+
55+
.. code-block:: bash
56+
57+
source /opt/ros/$ROS_DISTRO/setup.bash && source install/setup.bash
58+
4159
.. _install_with_pip:
4260

4361
Installation with pip as standalone Python package

0 commit comments

Comments
 (0)