Skip to content

Commit

Permalink
Documentation update with apt installation instructions (#220)
Browse files Browse the repository at this point in the history
  • Loading branch information
fmirus authored and fred-labs committed Nov 20, 2024
1 parent 705e7e9 commit cf5582d
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,60 @@
Setup
=====

Installation from source as ROS 2 workspace
-------------------------------------------
Installation with ROS 2
-----------------------

Prerequisites
^^^^^^^^^^^^^

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

Installation
^^^^^^^^^^^^^
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>`_.

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
Expand Down

0 comments on commit cf5582d

Please sign in to comment.