Skip to content

Commit

Permalink
Updated Documentation (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
smash0190 authored Sep 23, 2024
1 parent d8f1940 commit 8978a86
Showing 1 changed file with 15 additions and 22 deletions.
37 changes: 15 additions & 22 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,49 +11,39 @@ Have an NVIDIA GPU >= RTX 3070 to run Isaac Sim locally.
## Setup

### Clone

```
git clone --recursive -j8 [email protected]:castacks/AirStack.git
```

### Docker

Install [Docker Desktop](https://docs.docker.com/desktop/install/ubuntu/). This should come installed with docker compose.

### Omniverse Nucleus Server

Install the Omniverse launcher download from this link:

```
wget https://install.launcher.omniverse.nvidia.com/installers/omniverse-launcher-linux.AppImage
```

Follow these instructions to setup Nucleus : https://airlab.slite.com/app/docs/X8dZ8w5S3GP9tw
## Configure

Generate a Nucleus token by following the NVIDIA docs [here](https://docs.omniverse.nvidia.com/nucleus/latest/config-and-info/api_tokens.html).
Follow the instructions in `docker/isaac-sim/omni_pass.env` to configure the required settings for your Omniverse Nucelus Server token.
To generate a token, follow the NVIDIA docs [here](https://docs.omniverse.nvidia.com/nucleus/latest/config-and-info/api_tokens.html). See here for more information:
https://airlab.slite.com/app/docs/X8dZ8w5S3GP9tw

Make a copy of `docker/isaac-sim/omni_pass_TEMPLATE.env` to `docker/isaac-sim/omni_pass.env` and paste your token after `OMNI_PASS=`.
Also set the default OMNI_SERVER and accept the license terms. (Basti: The omni_server variable doesn't seem to work. The content browser might have to be edited manually the first time. To do that click:
"Add new connection ..." and enter airlab-storage.andrew.cmu.edu:8443 in the server field. Also if there is a localhost it should be removed since we are not running a local Nucleus server.

### Running.
## Getting Docker Images Ready
Now you have two options on how to proceed. You can build the docker image from scratch or pull the existing image on the airlab docker registry. Building the image from scratch can be useful if you would like to add new dependencies or add new custom functionality. For most users just pulling the existing image will be more conveninent and fast since it doesn't require access to the Nvidia registry.

Now you have two options on how to proceed. You can build the docker image from scratch or pull the existing image on the airlab docker registry. Building the image from scratch can be useful if you would like to add new dependencies or add new custom functionality. For most users just pulling the existing image will be more conveninent and fast since it doesn't require access to the Nvidia registry.

#### Option 1 (NOT READY YET): Use the Airlab Docker Registry
### Option 1 (Preferred): Use the Airlab Docker registry

To use the AirLab docker registry do the following

```bash
cd AirStack/docker/
docker login airlab-storage.andrew.cmu.edu:5001
## <Enter your andrew id (without @andrew.cmu.edu)>
## <Enter your andrew password>

## Pull the images in the docker compose file
docker compose pull
docker compose pull
```

When you execute docker compose pull in the next step the image will be pulled from the server automatically. This might take a while since the image is large.


#### Option 2: Setup from Scratch
1. SITL (Required until we add to docker image)

Expand All @@ -73,7 +63,10 @@ When you execute docker compose pull in the next step the image will be pulled f
docker compose build # build the images locally
```
IF you have permission you can now push an updated images to the docker server (only if it changed and is required)
```bash
docker compose push
```

## Launch

Expand Down

0 comments on commit 8978a86

Please sign in to comment.