Skip to content

Commit 8ba17c3

Browse files
committed
updated main README
1 parent b1b48ed commit 8ba17c3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# srpb
22

3-
The repository contains the source code of the SRPB - **S**ocial **R**obot navigation **P**lanners **B**enchmark.
3+
The repository contains the source code of the SRPB - **S**ocial **R**obot **P**lanners **B**enchmark - a benchmark that allows for quantitative evaluation of robot navigation performance and social aspects.
44

55
![Graphical abstract](doc/graphical_abstract.png)
66

77
The corresponding package that allows logging data while the robot is navigating (using ROS1 navigation stack) is available at [`srpb_move_base`](https://github.com/rayvburn/srpb_move_base).
88

9-
A log file is saved once the goal is reached by the `srpb_move_base` node. Renewing the goal pose before reaching the previous one does not cause the files to be divided into parts.
10-
119
A detailed description of metrics computation formulas is presented in the article [`Quantitative metrics for benchmarking human-aware robot navigation`](https://ieeexplore.ieee.org/document/10194930).
1210

1311
If you are using this benchmark in your research, please cite it as:
@@ -16,11 +14,11 @@ If you are using this benchmark in your research, please cite it as:
1614
@article{karwowski2023quantitative,
1715
author={Karwowski, Jarosław and Szynkiewicz, Wojciech},
1816
journal={IEEE Access},
19-
title={Quantitative metrics for benchmarking human-aware robot navigation},
17+
title={Quantitative Metrics for Benchmarking Human-Aware Robot Navigation},
2018
year={2023},
21-
volume={},
19+
volume={11},
2220
number={},
23-
pages={1-1},
21+
pages={79941-79953},
2422
doi={10.1109/ACCESS.2023.3299178}
2523
}
2624
```
@@ -37,12 +35,14 @@ rosinstall -n . srpb/srpb/srpb.rosinstall
3735

3836
## Usage
3937

40-
TBD
38+
A log file is saved once the goal is reached by the `srpb_move_base` node. Renewing the goal pose before reaching the previous one does not cause the files to be divided into parts.
39+
40+
TBD...
4141

4242
## Acknowledgments
4343

44-
The package was developed on top of [`MRPB`: Mobile Robot Local Planning Benchmark](https://github.com/NKU-MobFly-Robotics/local-planning-benchmark).
44+
The foundation of this package is [`MRPB`: Mobile Robot Local Planning Benchmark](https://github.com/NKU-MobFly-Robotics/local-planning-benchmark). There might be some shared sections of code, but overall, the original package has undergone a major overhaul.
4545

4646
## Contributing
4747

48-
Feel free to share your ideas, suggestions and contribute to the code development.
48+
Feel free to share your ideas, suggestions in Issues. Contributing to the code development is also appreciated.

0 commit comments

Comments
 (0)