From 6a57579bd7d2de8ada208326cf5f9ec909fe4d8c Mon Sep 17 00:00:00 2001 From: Florian Mirus Date: Mon, 21 Oct 2024 17:04:37 +0200 Subject: [PATCH] Documentation update with apt installation instructions (#220) --- docs/setup.rst | 40 +++++++++++++++++++++++++++++----------- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/docs/setup.rst b/docs/setup.rst index 0119ede0..1f530da7 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -2,42 +2,60 @@ Setup ===== -Installation from source as ROS 2 workspace -------------------------------------------- +Installation with ROS 2 +----------------------- Prerequisites ^^^^^^^^^^^^^ -Install ROS2 humble following the `installation instructions `_. +Install ROS2 following the `installation instructions `_ for your distribution `$ROS_DISTRO`. -Installation -^^^^^^^^^^^^^ +Scenario execution currently supports the ROS 2 distributions `Humble `_ and `Jazzy `_. -Clone the scenario execution repository +Installation as Debian package (recommended) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To install scenario execution together with all its libraries, run .. code-block:: bash - git clone https://github.com/IntelLabs/scenario_execution.git + sudo apt update && sudo apt install -y ros-$ROS_DISTRO-scenario_execution* + +To install just the core packages of scenario execution, run + +.. code-block:: bash + + sudo apt update && sudo apt install -y ros-$ROS_DISTRO-scenario_execution ros-$ROS_DISTRO-scenario_execution_ros ros-$ROS_DISTRO-scenario_execution_rviz -and update its submodules by running the following command in the root folder of the cloned repository + +Developer Installation (from source as ROS 2 workspace) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Clone the scenario execution repository .. code-block:: bash - git submodule update --init + git clone https://github.com/IntelLabs/scenario_execution.git -install the necessary dependencies +and install the necessary dependencies .. code-block:: bash rosdep install --from-paths . --ignore-src pip3 install -r requirements.txt -and build it +Now, build your workspace by running .. code-block:: bash colcon build +and source your installation by running + +.. code-block:: bash + + source /opt/ros/$ROS_DISTRO/setup.bash && source install/setup.bash + .. _install_with_pip: Installation with pip as standalone Python package