diff --git a/00_GettingStarted/README.md b/00_GettingStarted/README.md index da5bac21895598dfffeb79262c0629acd4276be8..ef8949b7d3b4977483b024eb9580f9cf228e34c3 100644 --- a/00_GettingStarted/README.md +++ b/00_GettingStarted/README.md @@ -77,31 +77,41 @@ Follow the instructions to download the repository to your local machine and sta - Open `VS Code`. - Go to *File* → *Open Folder* and select in the upcoming window the folder *your_local_path/i2r/* - Terminal (Linux, macOS): + ```bash cd <your local path>/i2r/ code . ``` + - Powershell (Windows) + ```bash ``` + 3. Open the *Terminal* in `VS Code` (*Terminal* → *New Terminal*). The path in the Terminal should be the one you selected before. 4. Now clone the repository from gitlab by copying the follwing command into the Terminal and press enter. (You are asked to enter your gitlab user name and password.) + ```bash git clone https://git.rwth-aachen.de/introduction-to-robotics-course/introduction-to-robotics-2023.git ``` + - If you don't have *git* installed, you can either install it or go to the gitlab repository using the browser and download the source code into the *i2r* folder. - Information on how to install git can be found for all OS [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) 5. Now that all the files from the repository are on your local machine, change in the terminal to the folder where the *docker-compose.yml* file is stored. + ```bash cd introduction-to-robotics-2023/00_GettingStarted/docker/i2r/ ``` -6. Run the following command to spin up the scenario that is defined in the [docker-compose.yml](docker/i2r/docker-compose.yml) file. + +6. Run the following command to spin up the scenario that is defined in the [docker-compose.yml](docker/i2r/docker-compose.yml) file. To be able to use all commands starting with *docker*, `Docker Desktop` has to run in the background. + ```bash docker compose up ``` - This command will download the needed images and start two containers. One container named ***i2r-ros-1*** which contains a snapshot of an Ubuntu OS with ROS and additional packages installed. The second container is an auxiliary container named ***i2r-gui-1*** that will be used to inspect graphical user interfaces of applications started in the i2r-ros-1 container. - + + This command will download the needed images and start two containers. One container named ***i2r-ros-1*** which contains a snapshot of an Ubuntu OS with ROS and additional packages installed. The second container is an auxiliary container named ***i2r-gui-1*** that will be used to inspect graphical user interfaces of applications started in the i2r-ros-1 container. + The terminal output will look the following:  @@ -110,11 +120,15 @@ Follow the instructions to download the repository to your local machine and sta *`Docker Desktop` GUI: Inside the Containers tab you should find the started group of containers.* - Another option to inspect the containers is using the terminal. (Note: If you are still in the terimal you executed the *docker compose up*, make sure to start a new terminl, but let the old terminal running.) + ```bash docker ps --all ``` + The terminal output will look the following: +  + There will be information like ID of the container, name of the image the container was build from etc. 8. To connect to the ***i2r-ros-1*** container, the container we will use to work with `ROS`, execute the following command from terminal: @@ -136,6 +150,27 @@ Follow the instructions to download the repository to your local machine and sta If that worked out, you can again close the the started *ROS Master* by typing *`Ctrl` + `C`*. That shuts down the *Master* node. To leave the *bash* session inside of the *i2r-ros-1 container* just type *`Ctrl` + `D`*.  +10. To stop the started group of containers named *i2r* you can either use the `Docker Desktop` GUI from the *Container* tab like shown below. + +  + + Or switch again to the terminal, where you run the *docker compose up* command and press *`Ctrl` + `C`*. + +  + +11. If all the previous steps worked you have successfully installed the envrionment we will be using during in `Introduction to Robotics` to work with `ROS`. + + If you want to restart a container just make sure that: + + - `Docker Desktop` is running and + - start the group of containers named *i2r* by using ... + - GUI or + +  + + - Terminal +  + ## In case of problems diff --git a/00_GettingStarted/images/docker_ps_all.gif b/00_GettingStarted/images/docker_ps_all.gif index d770431f65e2bfc55182e83dbfa7acdd8e24e5b7..38b2f167d18ec10be6d6b9f0ad8848f3f83592e2 100644 Binary files a/00_GettingStarted/images/docker_ps_all.gif and b/00_GettingStarted/images/docker_ps_all.gif differ diff --git a/00_GettingStarted/images/docker_ps_all.webm b/00_GettingStarted/images/docker_ps_all.webm index 723346ea20326f76da9668010086da3d5fb7f97b..b9d4a9b4712aa63b39f64944e931ebc7c07e4d35 100644 Binary files a/00_GettingStarted/images/docker_ps_all.webm and b/00_GettingStarted/images/docker_ps_all.webm differ diff --git a/00_GettingStarted/images/starting_container_group_from_gui.gif b/00_GettingStarted/images/starting_container_group_from_gui.gif new file mode 100644 index 0000000000000000000000000000000000000000..b748ea885aeca15db5fd20e357d624847d2d4296 Binary files /dev/null and b/00_GettingStarted/images/starting_container_group_from_gui.gif differ diff --git a/00_GettingStarted/images/starting_container_group_from_gui.webm b/00_GettingStarted/images/starting_container_group_from_gui.webm new file mode 100644 index 0000000000000000000000000000000000000000..5b77e4861d2422f114c608d9baed42839e109b26 Binary files /dev/null and b/00_GettingStarted/images/starting_container_group_from_gui.webm differ diff --git a/00_GettingStarted/images/starting_container_group_from_terminal.gif b/00_GettingStarted/images/starting_container_group_from_terminal.gif new file mode 100644 index 0000000000000000000000000000000000000000..1d1b50ddb8434df42c70c49e553e97b74fe5f5b8 Binary files /dev/null and b/00_GettingStarted/images/starting_container_group_from_terminal.gif differ diff --git a/00_GettingStarted/images/starting_container_group_from_terminal.webm b/00_GettingStarted/images/starting_container_group_from_terminal.webm new file mode 100644 index 0000000000000000000000000000000000000000..bbddab07a76dbf33d27d91faed0f2a74b8d057ae Binary files /dev/null and b/00_GettingStarted/images/starting_container_group_from_terminal.webm differ diff --git a/00_GettingStarted/images/stopping_container_group.gif b/00_GettingStarted/images/stopping_container_group.gif new file mode 100644 index 0000000000000000000000000000000000000000..c26680aaa88e7c78f09af98c8a7c7c657648dea1 Binary files /dev/null and b/00_GettingStarted/images/stopping_container_group.gif differ diff --git a/00_GettingStarted/images/stopping_container_group.webm b/00_GettingStarted/images/stopping_container_group.webm index a1dbc9a97e0fb243752990dd0d241af8bd843151..3c5c54ede641816b77fb4862b42110699749e46e 100644 Binary files a/00_GettingStarted/images/stopping_container_group.webm and b/00_GettingStarted/images/stopping_container_group.webm differ diff --git a/00_GettingStarted/images/stopping_container_group_from_gui.gif b/00_GettingStarted/images/stopping_container_group_from_gui.gif new file mode 100644 index 0000000000000000000000000000000000000000..ab9d03b5a344bc4bed286402a02e31732164fc1a Binary files /dev/null and b/00_GettingStarted/images/stopping_container_group_from_gui.gif differ diff --git a/00_GettingStarted/images/stopping_container_group_from_gui.webm b/00_GettingStarted/images/stopping_container_group_from_gui.webm new file mode 100644 index 0000000000000000000000000000000000000000..5ea70c24064e45331e78e926b3f82eefa2394166 Binary files /dev/null and b/00_GettingStarted/images/stopping_container_group_from_gui.webm differ