Skip to content

Commit 7ec4919

Browse files
mkhansenbotivanperez-keera
authored andcommitted
Add README with instructions for running Nav2 and SLAM (#126).
1 parent cf479a7 commit 7ec4919

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

navigation2/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Navigation2 Docker Image
2+
3+
The Navigation2 Docker image uses the Space ROS docker image (*osrf/spaceros:latest*) as its base image.
4+
The Navigation2 Dockerfile installs all of the prerequisite system dependencies to build Navigation2
5+
## Building the Navigation2 Image
6+
7+
To build the docker image, run:
8+
9+
```
10+
./build.sh
11+
```
12+
13+
The build process will take about 30 minutes, depending on the host computer.
14+
15+
## Running the Navigation2 Docker Image in a Container
16+
17+
After building the image, you can see the newly-built image by running:
18+
19+
```
20+
docker image list
21+
```
22+
23+
The output will look something like this:
24+
25+
```
26+
REPOSITORY TAG IMAGE ID CREATED SIZE
27+
osrf/space_nav2 latest 6edb2edc9643 10 hours ago 15.5GB
28+
openrobotics/spaceros latest 629b13cf7b74 12 hours ago 7.8GB
29+
nvidia/cudagl 11.4.1-devel-ubuntu20.04 336416dfcbba 1 week ago 5.35GB
30+
```
31+
32+
The new image is named **osrf/space_nav2:latest**.
33+
34+
There is a run.sh script provided for convenience that will run the spaceros image in a container.
35+
36+
```
37+
./run.sh
38+
```
39+
40+
Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files.
41+
You'll now be running inside the container and should see a prompt similar to this:
42+
43+
```
44+
root@ip-your-ip-address:/home/spaceros-user/nav2_ws#
45+
```
46+
47+
## Running Navigation2 Demo
48+
49+
To run the latest demo, see the README in the nav2_demos folder

0 commit comments

Comments
 (0)