Update keypoint-db/README.md
Browse files- keypoint-db/README.md +8 -54
keypoint-db/README.md
CHANGED
|
@@ -30,62 +30,16 @@ A containerized ROS2 development environment with GUI support and NVIDIA GPU acc
|
|
| 30 |
make
|
| 31 |
```
|
| 32 |
|
| 33 |
-
3. **
|
| 34 |
-
```bash
|
| 35 |
-
mkdir -p ./ws/src
|
| 36 |
-
# Copy your ROS2 packages to ws/src/
|
| 37 |
-
```
|
| 38 |
-
|
| 39 |
-
4. **Run container**
|
| 40 |
```bash
|
| 41 |
./run_container.sh
|
| 42 |
```
|
| 43 |
|
| 44 |
-
|
| 45 |
```bash
|
| 46 |
./join_container.sh
|
| 47 |
```
|
| 48 |
|
| 49 |
-
## Detailed Usage
|
| 50 |
-
|
| 51 |
-
### Building the Container
|
| 52 |
-
|
| 53 |
-
**Basic build:**
|
| 54 |
-
```bash
|
| 55 |
-
make
|
| 56 |
-
```
|
| 57 |
-
|
| 58 |
-
**Custom ROS2 distribution:**
|
| 59 |
-
```bash
|
| 60 |
-
ROS2_DISTRO=humble DOCKER_BUILD_OPTS="--no-cache" make
|
| 61 |
-
```
|
| 62 |
-
|
| 63 |
-
**Additional build options:**
|
| 64 |
-
```bash
|
| 65 |
-
DOCKER_BUILD_OPTS="--pull=true --no-cache" make
|
| 66 |
-
```
|
| 67 |
-
|
| 68 |
-
### Container Management
|
| 69 |
-
|
| 70 |
-
**Start main container:**
|
| 71 |
-
```bash
|
| 72 |
-
./run_container.sh
|
| 73 |
-
```
|
| 74 |
-
|
| 75 |
-
**Start with specific ROS2 distribution:**
|
| 76 |
-
```bash
|
| 77 |
-
./run_container.sh --distro humble
|
| 78 |
-
```
|
| 79 |
-
|
| 80 |
-
**Join running container from another terminal:**
|
| 81 |
-
```bash
|
| 82 |
-
./join_container.sh
|
| 83 |
-
```
|
| 84 |
-
|
| 85 |
-
**Alternative docker-compose method:**
|
| 86 |
-
```bash
|
| 87 |
-
docker compose run --rm --name ros2_devel_container ros2_dev_env bash
|
| 88 |
-
```
|
| 89 |
|
| 90 |
### ROS2 Development Workflow
|
| 91 |
|
|
@@ -100,20 +54,20 @@ rosdep install -i --from-path src --rosdistro ${ROS_DISTRO} -y
|
|
| 100 |
|
| 101 |
**Build workspace:**
|
| 102 |
```bash
|
| 103 |
-
|
| 104 |
```
|
| 105 |
|
| 106 |
-
**
|
| 107 |
```bash
|
| 108 |
-
|
| 109 |
```
|
| 110 |
|
| 111 |
-
**
|
| 112 |
```bash
|
| 113 |
-
|
| 114 |
-
colcon test-result --all
|
| 115 |
```
|
| 116 |
|
|
|
|
| 117 |
## Project Structure
|
| 118 |
|
| 119 |
```
|
|
|
|
| 30 |
make
|
| 31 |
```
|
| 32 |
|
| 33 |
+
3. **Run container**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
```bash
|
| 35 |
./run_container.sh
|
| 36 |
```
|
| 37 |
|
| 38 |
+
4. **Join from another terminal** (optional)
|
| 39 |
```bash
|
| 40 |
./join_container.sh
|
| 41 |
```
|
| 42 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 43 |
|
| 44 |
### ROS2 Development Workflow
|
| 45 |
|
|
|
|
| 54 |
|
| 55 |
**Build workspace:**
|
| 56 |
```bash
|
| 57 |
+
./compile_and_source.sh
|
| 58 |
```
|
| 59 |
|
| 60 |
+
**Run rviz with a layout:**
|
| 61 |
```bash
|
| 62 |
+
ros2 launch db_loader layout_visualization_launch.py json_file:=/home/user/ws/data/research.sc.s2016.json
|
| 63 |
```
|
| 64 |
|
| 65 |
+
**Source workspace:**
|
| 66 |
```bash
|
| 67 |
+
ros2 run db_loader keypoint_publisher chunk_1971-03-12T02_20_00Z_1971-03-12T02_25_00Z.csv
|
|
|
|
| 68 |
```
|
| 69 |
|
| 70 |
+
|
| 71 |
## Project Structure
|
| 72 |
|
| 73 |
```
|