Skip to content

Commit 96e3cbe

Browse files
committed
README updated (preliminary usage instructions)
1 parent 07a40dc commit 96e3cbe

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,18 @@ rosinstall -n . srpb/srpb/srpb.rosinstall
3535

3636
## Usage
3737

38+
### Setup
39+
3840
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.
3941

40-
TBD...
42+
### Typical workflow
43+
44+
If one intends to collect a bunch of logs, this is the correct workflow:
45+
46+
* instead of running the typical `move_base`, run the `srpb_move_base` node that aggregates the `srpb_logger` modules,
47+
* after each trial, run the `scripts/copy_logs.sh` to copy the logs related to the newest trial into a separate directory,
48+
* if one wishes to be extra safe, one might want to evaluate the newest logs at this point with `scripts/evaluate_from_dir.sh <PATH TO THE DIR WITH LOGS COPIED INTO>` OR (typically) once all trials were completed, run the `scripts/evaluate_all_dirs.sh <PATH TO THE MAIN DIR WITH LOGS GROUPED INTO DIRS>`,
49+
* now an Excel sheet can be created with `python3 create_excel_from_results.py` script.
4150

4251
## Acknowledgments
4352

0 commit comments

Comments
 (0)