Update docs on how to install pymrpt from ROS

MRPT · Jul 27, 2024 · 3121823 · 3121823
1 parent 239e92e
commit 3121823
Show file tree

Hide file tree

Showing 11 changed files with 26 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -63,29 +63,17 @@ Executables (`.exe`s and `.dll`s) and development libraries (`.h`s and `.lib`s)
 
 [Nightly built Windows installer](https://github.com/MRPT/mrpt/releases/tag/Windows-nightly-builds)
 
-### 3.4. As a ROS1/ROS2 package
+### 3.4. As a ROS package
 
-MRPT is also shipped as a ros1 & ros2 package named `mrpt2`, so it can be installed via: 
+MRPT is also shipped as ROS packages.
 
+For ROS 1:
 ```bash
+# (ROS 1 only!)
 sudo apt install ros-$ROS_DISTRO-mrpt2
 ```
 
-`mrpt2` status in ROS build farms:
-
-
-| Distro | `develop` branch  | Next builds | Stable release |
-|---|---|---|---|
-| ROS 1 Noetic @ u20.04 | [![Build Status](https://build.ros.org/job/Ndev__mrpt2__ubuntu_focal_amd64/badge/icon)](https://build.ros.org/job/Ndev__mrpt2__ubuntu_focal_amd64/) |  [![Build Status](https://build.ros.org/job/Nbin_uF64__mrpt2__ubuntu_focal_amd64__binary/badge/icon)](https://build.ros.org/job/Nbin_uF64__mrpt2__ubuntu_focal_amd64__binary/) | [![Version](https://img.shields.io/ros/v/noetic/mrpt2)](https://index.ros.org/search/?term=mrpt2) |
-| ROS 2 Humble @ u22.04 | [![Build Status](https://build.ros2.org/job/Hdev__mrpt2__ubuntu_jammy_amd64/badge/icon)](https://build.ros2.org/job/Hdev__mrpt2__ubuntu_jammy_amd64/) | [![Build Status](https://build.ros2.org/job/Hbin_uJ64__mrpt2__ubuntu_jammy_amd64__binary/badge/icon)](https://build.ros2.org/job/Hbin_uJ64__mrpt2__ubuntu_jammy_amd64__binary/) |  [![Version](https://img.shields.io/ros/v/humble/mrpt2)](https://index.ros.org/search/?term=mrpt2) | 
-| ROS 2 Iron @ u22.04 | [![Build Status](https://build.ros2.org/job/Idev__mrpt2__ubuntu_jammy_amd64/badge/icon)](https://build.ros2.org/job/Idev__mrpt2__ubuntu_jammy_amd64/) | [![Build Status](https://build.ros2.org/job/Ibin_uJ64__mrpt2__ubuntu_jammy_amd64__binary/badge/icon)](https://build.ros2.org/job/Ibin_uJ64__mrpt2__ubuntu_jammy_amd64__binary/) | [![Version](https://img.shields.io/ros/v/iron/mrpt2)](https://index.ros.org/search/?term=mrpt2) | 
-| ROS 2 Jazzy @ u24.04 | [![Build Status](https://build.ros2.org/job/Jdev__mrpt2__ubuntu_noble_amd64/badge/icon)](https://build.ros2.org/job/Jdev__mrpt2__ubuntu_noble_amd64/) | [![Build Status](https://build.ros2.org/job/Jbin_uN64__mrpt2__ubuntu_noble_amd64__binary/badge/icon)](https://build.ros2.org/job/Jbin_uN64__mrpt2__ubuntu_noble_amd64__binary/) | [![Version](https://img.shields.io/ros/v/jazzy/mrpt2)](https://index.ros.org/search/?term=mrpt2) | 
-| ROS 2 Rolling @ u24.04 | [![Build Status](https://build.ros2.org/job/Rdev__mrpt2__ubuntu_noble_amd64/badge/icon)](https://build.ros2.org/job/Rdev__mrpt2__ubuntu_noble_amd64/) | [![Build Status](https://build.ros2.org/job/Rbin_uN64__mrpt2__ubuntu_noble_amd64__binary/badge/icon)](https://build.ros2.org/job/Rbin_uN64__mrpt2__ubuntu_noble_amd64__binary/) | [![Version](https://img.shields.io/ros/v/rolling/mrpt2)](https://index.ros.org/search/?term=mrpt2) |
-
-| EOL Distro | Last release |
-|---|---|
-| ROS1 Melodic @ u18.04 | [![Version](https://img.shields.io/ros/v/melodic/mrpt2)](https://index.ros.org/search/?term=mrpt2) |
-| ROS2 Foxy @ u20.04 | [![Version](https://img.shields.io/ros/v/foxy/mrpt2)](https://index.ros.org/search/?term=mrpt2) |
+For ROS 2, see instructions and available versions: https://github.com/MRPT/mrpt_ros
 
 
 ## 4. License

diff --git a/doc/source/wrappers.rst b/doc/source/wrappers.rst
@@ -8,24 +8,19 @@ Wrappers
 
 1. MRPT ROS packages
 ----------------------
-
 The following ROS packages are provided wrapping MRPT functionality:
 
-- `mrpt2 <https://wiki.ros.org/mrpt2>`_: For older Ubuntu distributions, this ROS package provides a more recent version of MRPT 2.x.x so users do not need to build it from sources.
+- MRPT libraries and pymrpt:
+  - ROS 1: `mrpt2 <https://wiki.ros.org/mrpt2>`_
+  - ROS 2: See instructions in: https://github.com/MRPT/mrpt_ros
 - `mrpt_msgs <https://github.com/mrpt-ros-pkg/mrpt_msgs>`_: ROS messages for MRPT classes and objects
 - `mrpt_navigation <https://wiki.ros.org/mrpt_navigation>`_: Reactive autonomous navigation algorithms.
 - `mrpt_sensors <https://wiki.ros.org/mrpt_sensors>`_: Reading from diverse sensors (:ref:`supported-sensors`).
 - `mrpt_slam <https://wiki.ros.org/mrpt_slam>`_: Basic 2D and 3D SLAM algorithms.
 - `pose_cov_ops <https://wiki.ros.org/pose_cov_ops>`_: SE(2) and SE(3) pose probability density function manipulation library.
 
-See also MRPT ROS packages status table for:
-
-- `Melodic <https://repositories.ros.org/status_page/ros_melodic_default.html?q=mrpt>`_
-- `Noetic <https://repositories.ros.org/status_page/ros_noetic_default.html?q=mrpt>`_
-
 2. Python 
 ----------------------
-
 All MRPT libraries are wrapped into one single Python3 module `pymrpt`.
 See: 
 
@@ -35,6 +30,5 @@ See:
 
 3. Matlab
 ----------------------
-
 Part of MRPT can be compiled into a .mex file and used directly from MATLAB.
 Read more `here <https://github.com/MRPT/mrpt/wiki/MatlabBindings>`_.
diff --git a/python-examples/global_localization.py b/python-examples/global_localization.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/hwdriver-tao-imu-usb.py b/python-examples/hwdriver-tao-imu-usb.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/lines-3d-geometry-example.py b/python-examples/lines-3d-geometry-example.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/matrices.py b/python-examples/matrices.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/opengl-demo-gui.py b/python-examples/opengl-demo-gui.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/rbpf_slam.py b/python-examples/rbpf_slam.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/ros-poses-convert.py b/python-examples/ros-poses-convert.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/se2-poses-example.py b/python-examples/se2-poses-example.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------
 

diff --git a/python-examples/se3-poses-example.py b/python-examples/se3-poses-example.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # ---------------------------------------------------------------------
-# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
+# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
+# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
 # export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
 # ---------------------------------------------------------------------