Skip to content

Commit 06ec144

Browse files
committed
change name of Dockerfile and updated readme.
1 parent b696cfb commit 06ec144

3 files changed

Lines changed: 31 additions & 33 deletions

File tree

.github/workflows/headless-simulation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323

2424
- name: Build Docker image
2525
run: |
26-
docker build -f Dockerfile.headless -t rumarino-headless:latest .
26+
docker build -t rumarino-headless:latest .
2727
2828
- name: Run headless simulation test
2929
run: |
File renamed without changes.

README.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,36 @@
11

2-
## Simulation:
3-
2+
## Simulation
43

54
### Clone and go in repo
65
```sh
7-
git clone --recurisve git@github.com:joseburgosguntin/rumarino-ros2-jazzy.git
6+
git clone --recursive git@github.com:joseburgosguntin/rumarino-ros2-jazzy.git
87
cd ./rumarino-ros2-jazzy
98
```
109

10+
## Quick Start with Docker (Recommended for CI/CD)
11+
12+
```bash
13+
# Build the Docker image
14+
docker build -t rumarino-headless:latest .
1115

12-
## System Dependencies
16+
# Run headless simulation test
17+
docker run --rm \
18+
--name headless-test \
19+
rumarino-headless:latest \
20+
bash -c "
21+
source /opt/ros/jazzy/setup.bash && \
22+
source /ros2_ws/install/setup.bash && \
23+
ros2 launch bringup test_mission_executor_headless.launch.py \
24+
mission_name:=prequalify \
25+
env_file_name:=hydrus_env_headless.scn &
26+
LAUNCH_PID=\$! && \
27+
simulation_health_check --duration 15 && \
28+
kill \$LAUNCH_PID 2>/dev/null || true
29+
"
30+
```
31+
32+
## Local Development Setup
33+
System Dependencies
1334

1435
### Required Tools
1536
- Python 3
@@ -78,8 +99,9 @@ sudo make install
7899
cd ../../../../../
79100
```
80101

81-
## Test mission\_executor
102+
## Test mission_executor
82103

104+
### With GUI (local development)
83105
```sh
84106
# Navigate to the workspace
85107
cd ~/ros2_ws/rumarino-ros2-jazzy
@@ -90,43 +112,19 @@ source /usr/lib64/ros2-jazzy/setup.zsh
90112
# Ubuntu:
91113
source /opt/ros/jazzy/setup.bash
92114

93-
94115
# Build packages
95116
colcon build --packages-select interfaces bringup Stonefish stonefish_ros2 controller_stonefish mission_executor
96117

97118
# Source the workspace
98-
#Fedora
119+
# Fedora
99120
source install/setup.sh
100-
#Ubuntu
121+
# Ubuntu
101122
source install/setup.bash
102123

124+
# Run with GUI
103125
ros2 launch bringup test_mission_executor.launch.py mission_name:=prequalify env_file_name:=hydrus_env.scn
104126
```
105127

106-
## Test Mission Executer in Docker
107-
108-
109-
```bash
110-
docker build -f Dockerfile.headless -t rumarino-headless:latest .
111-
112-
docker run --rm \
113-
--name headless-test \
114-
rumarino-headless:latest \
115-
bash -c "
116-
source /opt/ros/jazzy/setup.bash && \
117-
source /ros2_ws/install/setup.bash && \
118-
119-
ros2 launch bringup test_mission_executor_headless.launch.py \
120-
mission_name:=prequalify \
121-
env_file_name:=hydrus_env_headless.scn &
122-
LAUNCH_PID=\$! && \
123-
124-
simulation_health_check --duration 15 && \
125-
126-
# Kill simulation
127-
kill \$LAUNCH_PID 2>/dev/null || true
128-
129-
```
130128

131129

132130
## Computer Vision

0 commit comments

Comments
 (0)