Skip to content

Commit dd2c0d3

Browse files
author
Mulo01
committedSep 19, 2024·
Update Readme
1 parent 5b7e5ed commit dd2c0d3

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed
 

‎README.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,21 @@ A 4D (X,Y,Z, Theta) Planner for unmaned ground vehicles (UGVs).
1010
<img src="doc/figures/ugv_nav4d_logo.jpeg" height= "200" width="200"/>
1111
</figure>
1212

13+
## Statement of need
14+
Accurate ground surface representation is crucial for ground-based robots in complex terrains. The [ROS2 Navigation Stack](https://docs.nav2.org/), which uses voxel maps for 3D navigation, often loses detail and accuracy, especially in multi-storey environments, due to its discrete voxelization and separate costmaps for each floor.
15+
16+
We propose ugv_nav4d, a path planner that enhances environmental representation with [Multi-Layered Surface Maps](https://github.com/envire/slam-maps) (MLS) and a 3D [Traversability Map](https://github.com/dfki-ric/traversability_generator3d.git). Ugv_nav4d avoids the "stepping" effect of voxel maps by using a continuous grid and detailed vertical information, providing smoother and more accurate terrain modeling.
17+
18+
Unlike nav2, ugv_nav4d simplifies planning with a single TraversabilityMap3D, which contains detailed ground surface data, offering a superior alternative to nav2’s 3D costmaps. For users, MLS maps provide a smoother, more realistic view of terrain compared to the blocky voxel maps, enhancing navigation and decision-making in complex environments.
19+
1320
## Installation
1421

1522
Follow the steps to peform a standalone build of the library.
1623

1724
### System Requirements
1825

1926
```
20-
OS: Ubuntu 20.04, Ubuntu 22.04 (Recommended)
27+
OS: Ubuntu 20.04, Ubuntu 22.04, Ubuntu 24.04
2128
2229
```
2330
See [install_os_dependencies.bash](source_dependencies/install_os_dependencies.bash) for further os dependencies.
@@ -64,15 +71,8 @@ make install
6471
#### Compiling inside a ROCK environment [Only for ROCK users]
6572
See the `manifest.xml` for an up to date list of dependencies. If you are ROCK user then include the package_set which contains the ```dfki-ric/orogen-ugv_nav4d``` package in your autoproj manifest file.
6673

67-
#### Generate API Documentation
68-
The API documentation is generated based on doxygen. You do not need to install doxygen because it is installed as part of the ```install_os_dependencies.bash``` script used in the previous step.
69-
70-
You just need to run the ```make doc``` command in the ugv_nav4d build folder. The doxygen documentation will be automatically generated in the ```build/doc``` folder.
71-
72-
```
73-
cd build/
74-
make doc
75-
```
74+
#### API Documentation
75+
The API documentation can be found at https://dfki-ric.github.io/ugv_nav4d/
7676

7777
#### GUI Usage & Tests
7878

@@ -123,8 +123,6 @@ At the end you should see the output
123123
### Planning
124124
The planner is based on SBPL (http://www.sbpl.net/). I.e. it uses the SBPLs ARA* planner to plan in a custom environment.
125125

126-
TODO parallellism
127-
128126
#### Environment
129127
SBPL internally uses states (identified by an id only) and associated costs (a unitless integer). The state ids reference states of an environment. That environment has to be defined by the user.
130128
The planner contains the `EnvironmentXYZTheta`. This environment implements all interfaces needed by SBPL to enable ARA* planning (other planning algorithms might require additional interfaces).

0 commit comments

Comments
 (0)
Please sign in to comment.