|
2 | 2 | Setup |
3 | 3 | ===== |
4 | 4 |
|
5 | | -Installation from source as ROS 2 workspace |
6 | | -------------------------------------------- |
| 5 | +Installation with ROS 2 |
| 6 | +----------------------- |
7 | 7 |
|
8 | 8 | Prerequisites |
9 | 9 | ^^^^^^^^^^^^^ |
10 | 10 |
|
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`. |
12 | 12 |
|
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>`_. |
15 | 14 |
|
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 |
17 | 19 |
|
18 | 20 | .. code-block:: bash |
19 | 21 |
|
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 |
21 | 29 |
|
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 |
23 | 35 |
|
24 | 36 | .. code-block:: bash |
25 | 37 |
|
26 | | - git submodule update --init |
| 38 | + git clone https://github.com/IntelLabs/scenario_execution.git |
27 | 39 |
|
28 | | -install the necessary dependencies |
| 40 | +and install the necessary dependencies |
29 | 41 |
|
30 | 42 | .. code-block:: bash |
31 | 43 |
|
32 | 44 | rosdep install --from-paths . --ignore-src |
33 | 45 | pip3 install -r requirements.txt |
34 | 46 |
|
35 | | -and build it |
| 47 | +Now, build your workspace by running |
36 | 48 |
|
37 | 49 | .. code-block:: bash |
38 | 50 |
|
39 | 51 | colcon build |
40 | 52 |
|
| 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 | +
|
41 | 59 | .. _install_with_pip: |
42 | 60 |
|
43 | 61 | Installation with pip as standalone Python package |
|
0 commit comments