Skip to content

Commit 3121823

Browse files
jlblancocjlblancoc
committed
Update docs on how to install pymrpt from ROS
1 parent 239e92e commit 3121823

11 files changed

+26
-35
lines changed

‎README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -63,29 +63,17 @@ Executables (`.exe`s and `.dll`s) and development libraries (`.h`s and `.lib`s)
6363

6464
[Nightly built Windows installer](https://github.com/MRPT/mrpt/releases/tag/Windows-nightly-builds)
6565

66-
### 3.4. As a ROS1/ROS2 package
66+
### 3.4. As a ROS package
6767

68-
MRPT is also shipped as a ros1 & ros2 package named `mrpt2`, so it can be installed via:
68+
MRPT is also shipped as ROS packages.
6969

70+
For ROS 1:
7071
```bash
72+
# (ROS 1 only!)
7173
sudo apt install ros-$ROS_DISTRO-mrpt2
7274
```
7375

74-
`mrpt2` status in ROS build farms:
75-
76-
77-
| Distro | `develop` branch | Next builds | Stable release |
78-
|---|---|---|---|
79-
| 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) |
80-
| 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) |
81-
| 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) |
82-
| 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) |
83-
| 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) |
84-
85-
| EOL Distro | Last release |
86-
|---|---|
87-
| ROS1 Melodic @ u18.04 | [![Version](https://img.shields.io/ros/v/melodic/mrpt2)](https://index.ros.org/search/?term=mrpt2) |
88-
| ROS2 Foxy @ u20.04 | [![Version](https://img.shields.io/ros/v/foxy/mrpt2)](https://index.ros.org/search/?term=mrpt2) |
76+
For ROS 2, see instructions and available versions: https://github.com/MRPT/mrpt_ros
8977

9078

9179
## 4. License

‎doc/source/wrappers.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,19 @@ Wrappers
88

99
1. MRPT ROS packages
1010
----------------------
11-
1211
The following ROS packages are provided wrapping MRPT functionality:
1312

14-
- `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.
13+
- MRPT libraries and pymrpt:
14+
- ROS 1: `mrpt2 <https://wiki.ros.org/mrpt2>`_
15+
- ROS 2: See instructions in: https://github.com/MRPT/mrpt_ros
1516
- `mrpt_msgs <https://github.com/mrpt-ros-pkg/mrpt_msgs>`_: ROS messages for MRPT classes and objects
1617
- `mrpt_navigation <https://wiki.ros.org/mrpt_navigation>`_: Reactive autonomous navigation algorithms.
1718
- `mrpt_sensors <https://wiki.ros.org/mrpt_sensors>`_: Reading from diverse sensors (:ref:`supported-sensors`).
1819
- `mrpt_slam <https://wiki.ros.org/mrpt_slam>`_: Basic 2D and 3D SLAM algorithms.
1920
- `pose_cov_ops <https://wiki.ros.org/pose_cov_ops>`_: SE(2) and SE(3) pose probability density function manipulation library.
2021

21-
See also MRPT ROS packages status table for:
22-
23-
- `Melodic <https://repositories.ros.org/status_page/ros_melodic_default.html?q=mrpt>`_
24-
- `Noetic <https://repositories.ros.org/status_page/ros_noetic_default.html?q=mrpt>`_
25-
2622
2. Python
2723
----------------------
28-
2924
All MRPT libraries are wrapped into one single Python3 module `pymrpt`.
3025
See:
3126

@@ -35,6 +30,5 @@ See:
3530

3631
3. Matlab
3732
----------------------
38-
3933
Part of MRPT can be compiled into a .mex file and used directly from MATLAB.
4034
Read more `here <https://github.com/MRPT/mrpt/wiki/MatlabBindings>`_.

‎python-examples/global_localization.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/hwdriver-tao-imu-usb.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/lines-3d-geometry-example.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/matrices.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/opengl-demo-gui.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/rbpf_slam.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/ros-poses-convert.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

‎python-examples/se2-poses-example.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/usr/bin/env python3
22

33
# ---------------------------------------------------------------------
4-
# Install python3-pymrpt, ros-$ROS_DISTRO-mrpt2, or test with a local build with:
4+
# Install python3-pymrpt, ros-$ROS_DISTRO-python-mrpt,
5+
# ros-$ROS_DISTRO-mrpt2, or test with a local build with:
56
# export PYTHONPATH=$HOME/code/mrpt/build-Release/:$PYTHONPATH
67
# ---------------------------------------------------------------------
78

0 commit comments

Comments
 (0)