Skip to content

Commit

Permalink
Add README with instructions for running Nav2 and SLAM (#126).
Browse files Browse the repository at this point in the history
  • Loading branch information
mkhansenbot authored and ivanperez-keera committed Jan 30, 2024
1 parent cf479a7 commit 7ec4919
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions navigation2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Navigation2 Docker Image

The Navigation2 Docker image uses the Space ROS docker image (*osrf/spaceros:latest*) as its base image.
The Navigation2 Dockerfile installs all of the prerequisite system dependencies to build Navigation2
## Building the Navigation2 Image

To build the docker image, run:

```
./build.sh
```

The build process will take about 30 minutes, depending on the host computer.

## Running the Navigation2 Docker Image in a Container

After building the image, you can see the newly-built image by running:

```
docker image list
```

The output will look something like this:

```
REPOSITORY TAG IMAGE ID CREATED SIZE
osrf/space_nav2 latest 6edb2edc9643 10 hours ago 15.5GB
openrobotics/spaceros latest 629b13cf7b74 12 hours ago 7.8GB
nvidia/cudagl 11.4.1-devel-ubuntu20.04 336416dfcbba 1 week ago 5.35GB
```

The new image is named **osrf/space_nav2:latest**.

There is a run.sh script provided for convenience that will run the spaceros image in a container.

```
./run.sh
```

Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files.
You'll now be running inside the container and should see a prompt similar to this:

```
root@ip-your-ip-address:/home/spaceros-user/nav2_ws#
```

## Running Navigation2 Demo

To run the latest demo, see the README in the nav2_demos folder

0 comments on commit 7ec4919

Please sign in to comment.