55Build & Install
66=================
77
8- This page explains how to install and build the **EasyNavigation (EasyNav) ** framework.
9- If you are new here, start with :doc: `../getting_started/index ` for a high‑level overview,
10- then return to this guide to set up your development environment.
8+ This page explains how to install and build the **EasyNavigation (EasyNav) ** framework and how to set up your development environment.
119
1210.. contents :: On this page
1311 :local:
@@ -18,7 +16,8 @@ Supported platforms
1816
1917EasyNav targets modern Linux distributions and ROS 2 releases:
2018
21- - **Ubuntu 24.04 (Noble) ** — ROS 2 *kilted * (primary CI target)
19+ - **Ubuntu 24.04 (Noble) ** — ROS 2 *jazzy * (primary CI target)
20+ - **Ubuntu 24.04 (Noble) ** — ROS 2 *kilted *
2221- **Ubuntu 24.04 (Noble) ** — ROS 2 *rolling *
2322- Other platforms may work but are not actively tested.
2423
@@ -30,15 +29,15 @@ Prerequisites
3029-------------
3130
3231
33- 1. ROS 2 (kilted or rolling)
32+ 1. ROS 2 (jazzy, kilted or rolling)
3433
3534 Follow the official ROS 2 installation instructions for your platform.
3635 Ensure your ROS 2 environment is sourced before building EasyNav.
3736
3837 .. code-block :: bash
3938
4039 # Example (adjust to your ROS 2 distro):
41- source /opt/ros/kilted /setup.bash
40+ source /opt/ros/jazzy /setup.bash
4241
4342 2. ROS dependencies
4443
@@ -60,7 +59,7 @@ Binary packages will be provided via APT for Ubuntu + ROS 2 as they become avail
6059 .. code-block :: bash
6160
6261 sudo apt update
63- sudo apt install ros-kilted -easynav
62+ sudo apt install ros-jazzy -easynav
6463
6564 Build from source
6665-----------------
@@ -72,21 +71,24 @@ We recommend a standard ROS 2 workspace:
7271
7372.. code-block :: bash
7473
75- mkdir -p ~ /ros/ros2/ easynav_ws/src
76- cd ~ /ros/ros2/ easynav_ws
74+ mkdir -p ~ /easynav_ws/src
75+ cd ~ /easynav_ws
7776
7877 Clone sources
7978~~~~~~~~~~~~~
8079
81- You can retrieve EasyNav sources either by cloning the monorepo(s) you need:
80+ You can retrieve EasyNav sources by cloning the monorepo(s) you need:
8281
8382.. code-block :: bash
8483
85- cd ~ /ros/ros2/easynav_ws/src
86- # Core/meta repositories (examples — adjust to your needs)
87- git clone https://github.com/EasyNavigation/EasyNavigation.git
88- git clone https://github.com/EasyNavigation/easynav_plugins.git
89- git clone https://github.com/EasyNavigation/NavMap.git
84+ # Adjust workspace dir and branches to your needs
85+ cd ~ /easynav_ws/src
86+ # Clone the main EasyNavigation repositories
87+ git clone -b jazzy https://github.com/EasyNavigation/EasyNavigation.git
88+ git clone -b jazzy https://github.com/EasyNavigation/NavMap.git
89+ git clone -b jazzy https://github.com/EasyNavigation/easynav_plugins.git
90+ # Clone yaets dependency
91+ git clone -b jazzy-devel https://github.com/fmrico/yaets.git
9092
9193
9294 Install dependencies
@@ -96,7 +98,7 @@ From the workspace root, resolve all package dependencies with rosdep:
9698
9799.. code-block :: bash
98100
99- cd ~ /ros/ros2/ easynav_ws
101+ cd ~ /easynav_ws
100102 rosdep install --from-paths src --ignore-src -y -r
101103
102104 Configure and build
@@ -106,35 +108,28 @@ Use colcon to build the workspace. You may enable symlink-install for faster ite
106108
107109.. code-block :: bash
108110
109- cd ~ /ros/ros2/ easynav_ws
111+ cd ~ /easynav_ws
110112 colcon build --symlink-install
111113
112114 Source the overlay
113115~~~~~~~~~~~~~~~~~~
114116
115117.. code-block :: bash
116118
117- # Source ROS 2 first (kilted / rolling)
118- source /opt/ros/kilted /setup.bash
119+ # Source ROS 2 first (jazzy / kilted / rolling)
120+ source /opt/ros/jazzy /setup.bash
119121 # Then source the workspace
120- source ~ /ros/ros2/ easynav_ws/install/setup.bash
122+ source ~ /easynav_ws/install/setup.bash
121123
122124 Run tests (optional)
123125~~~~~~~~~~~~~~~~~~~~
124126
125127.. code-block :: bash
126128
127- cd ~ /ros/ros2/ easynav_ws
129+ cd ~ /easynav_ws
128130 colcon test --ctest-args -R easynav # run EasyNav-related tests
129131 colcon test-result --verbose
130132
131- Common options
132- --------------
133-
134- - **Release build: ** ``--cmake-args -DCMAKE_BUILD_TYPE=Release ``
135- - **Verbose build: ** ``--event-handlers console_cohesion+ ``
136- - **Single package: ** ``--packages-select <pkg_name> ``
137- - **Parallel jobs: ** ``--parallel-workers $(nproc) ``
138133
139134 Troubleshooting
140135---------------
@@ -151,16 +146,16 @@ Troubleshooting
151146
152147 .. code-block :: bash
153148
154- source /opt/ros/kilted /setup.bash
155- source ~ /ros/ros2/ easynav_ws/install/setup.bash
149+ source /opt/ros/jazzy /setup.bash
150+ source ~ /easynav_ws/install/setup.bash
156151
157152 - **ABI / compiler issues **
158153
159154 Remove the build, install, and log folders and rebuild:
160155
161156 .. code-block :: bash
162157
163- cd ~ /ros/ros2/ easynav_ws
158+ cd ~ /easynav_ws
164159 rm -rf build install log
165160 colcon build --merge-install
166161
@@ -171,7 +166,7 @@ Since this is a workspace overlay, you can remove it safely:
171166
172167.. code-block :: bash
173168
174- rm -rf ~ /ros/ros2/ easynav_ws
169+ rm -rf ~ /easynav_ws
175170
176171 Next steps
177172----------
@@ -181,4 +176,4 @@ Next steps
181176- :doc: `../developer_guide/index ` — in-depth documentation for developers and contributors
182177
183178.. toctree ::
184- :hidden:
179+ :hidden:
0 commit comments