Skip to content

Commit

Permalink
Add dcoker image URL (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
kanishkegb authored Aug 27, 2023
1 parent 30ecc3a commit 361d1cc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[![Build Status](https://app.travis-ci.com/fdcl-gwu/uav_simulator.svg?branch=main)](https://app.travis-ci.com/fdcl-gwu/uav_simulator)
|![TravisCI](https://img.shields.io/badge/travis%20ci-%232B2F33.svg?style=for-the-badge&logo=travis&logoColor=white) | ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)|
|-|-|
|[![Build Status](https://app.travis-ci.com/fdcl-gwu/uav_simulator.svg?branch=main)](https://app.travis-ci.com/fdcl-gwu/uav_simulator) | [tag:ros-noetic](https://hub.docker.com/layers/kanishgama/uav_simulator/ros-noetic/images/sha256-84b08eedc786c7d9ff06282816560876bb384ec52e0a7da9739e5cbd749e4d0b?context=repo) |

# Python - Gazebo Simulation Environment for a UAV with Geometric Control

Expand Down Expand Up @@ -116,12 +118,19 @@ This has not been tested on other OS versions.
1. Install docker following [official instructions](https://docs.docker.com/engine/install/ubuntu/).
1. If you are not already there, `cd uav_simulator`
1. Enable xhost (required for Gazebo and GUI): `xhost +`
1. Build the docker image: `docker build -t uav_simulator .`
1. Build the docker image: `docker build -t uav_simulator .` (see following paragraph if you just want to pull the built image instead)
1. Run a container: `bash docker_run.sh`

The last command will start a docker container, install all the dependencies, and mount the local directory there.
The first time you run the build command will take a while as it installs all the libraries.

You can skip the build command altogether by pulling the built docker from the Docker Hub with the following command.
This is NOT required if you are building it locally using the build command.
```sh
docker pull kanishgama/uav_simulator:ros-noetic
bash docker_run.sh
```

After that, you only need to run the `bash docker_run.sh` every time you need to run the simulation.
Since this mounts the local repository inside the docker, you just need to change the code in your local repository, and it will be automatically update inside the docker.

Expand Down
3 changes: 3 additions & 0 deletions docker_release.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
docker build --tag <tag-name> -t uav_simulator .
docker tag uav_simulator kanishgama/uav_simulator:<tag-name>
docker push kanishgama/uav_simulator:<tag-name>

0 comments on commit 361d1cc

Please sign in to comment.