diff --git a/docs/src/getting_started/installation/docker.md b/docs/src/getting_started/installation/docker.md index c172910..c941019 100644 --- a/docs/src/getting_started/installation/docker.md +++ b/docs/src/getting_started/installation/docker.md @@ -9,7 +9,6 @@ First, install Docker Engine by following the [official installation instruction ```bash curl -fsSL https://get.docker.com | sh sudo systemctl enable --now docker - sudo groupadd docker sudo usermod -aG docker $USER newgrp docker @@ -27,39 +26,7 @@ sudo nvidia-ctk runtime configure --runtime=docker sudo systemctl restart docker ``` -## 3. Gain Access to the [Isaac Sim Docker Image](https://catalog.ngc.nvidia.com/orgs/nvidia/containers/isaac-sim) - -To run the simulation, you need access to the Isaac Sim Docker image, which requires registering an account and generating an API key from NVIDIA GPU Cloud (NGC). - -### 3.1 Register and Log In to [NVIDIA GPU Cloud (NGC)](https://www.nvidia.com/en-us/gpu-cloud) - -Visit the [NGC portal](https://ngc.nvidia.com/signin) and register or log in to your account. - -### 3.2 Generate Your [NGC API Key](https://docs.nvidia.com/ngc/gpu-cloud/ngc-user-guide/README.md#ngc-api-keys) - -Follow the [official guide](https://docs.nvidia.com/ngc/gpu-cloud/ngc-user-guide/README.md#generating-personal-api-key) to generate your personal NGC API key. - -### 3.3 Log In to NGC via Docker - -Once you have your API key, log in to NGC through Docker: - -```bash -docker login nvcr.io -``` - -When prompted for a username, enter `$oauthtoken` (exactly as shown): - -```bash -Username: $oauthtoken -``` - -When prompted for a password, use the API key you just generated: - -```bash -Password: -``` - -## 4. Clone the Repository +## 3. Clone the Repository Next, clone the `space_robotics_bench` repository locally. Make sure to include the `--recurse-submodules` flag to clone also the submodule containing simulation assets. @@ -67,16 +34,16 @@ Next, clone the `space_robotics_bench` repository locally. Make sure to include git clone --recurse-submodules https://github.com/AndrejOrsula/space_robotics_bench.git ``` -## 5. Build the Docker Image +## 4. Build the Docker Image (Optional) -Now, you can build the Docker image for `space_robotics_bench` by running the provided [`.docker/build.bash`](https://github.com/AndrejOrsula/space_robotics_bench/blob/main/.docker/build.bash) script. Note that the first build process may take up to 30 minutes (depending on your network speed and system configuration). +> This step is now optional and can be skipped by continuing directly to the instructions about the [Basic Usage](../usage.md). The Docker image is available on [Docker Hub](https://hub.docker.com/r/andrejorsula/space_robotics_bench), and it will be automatically pulled when you run the benchmark via Docker for the first time (usually faster than building it locally). + +You can build the Docker image for `space_robotics_bench` by running the provided [`.docker/build.bash`](https://github.com/AndrejOrsula/space_robotics_bench/blob/main/.docker/build.bash) script. Note that the first build process may take up to 30 minutes (depending on your network speed and system configuration). ```bash space_robotics_bench/.docker/build.bash ``` -## 6. Verify the Image Build - To ensure that the image was built successfully, run the following command. You should see the `space_robotics_bench` image listed among recently created Docker images. ```bash