Update Quickstart

ReadMe Update

Author: shanereetz

README.md

@@ -20,73 +20,81 @@ Through this project, users can interact with Isaac Sim and Isaac Lab purely fro
 ### Quickstart Guide
 This guide will get you started with a Visual Studio Code instance with Isaac Lab preinstalled, and an in-browser user interface provided by Kit App Streaming.
 
-1. Click the Deploy Now button below
+1. Click this Deploy Now button
 [![ Click here to deploy.](https://brev-assets.s3.us-west-1.amazonaws.com/nv-lb-dark.svg)](https://brev.nvidia.com/launchable/deploy?launchableID=env-31ezDWyp4LvtDQr5rUhAWOUMFhn)
+2. Click the Deploy Launchable button to spin up the instance.
+3. Wait for the instance to be fully ready on Brev: running, built, and the setup script has completed (first launch can take a while)
+4. On the Brev instance page, scroll to the TCP/UDP ports section.
+5. Click the link for port 80 (HTTP) to open Visual Studio Code Server.
+6. The default password is `password`. This can be modified.
+7. Inside Visual Studio Code, continue with the [README.md](https://github.com/isaac-sim/isaac-launchable/blob/main/isaac-lab/vscode/README.md) instructions. A summary is provided below.
 
-2. Wait for the the instance to be fully ready on Brev. The first time, this will take a while. Wait for it to be running, built, and for the setup script is complete.
-3. Scroll down to the TCP/UDP ports section of the Brev instance page.
-4. Click the link associated with port 80 - this will take you to Visual Studio Code Server.
-5. The default password is `password`. This can be modified.
-6. Continue with the [README.md](https://github.com/isaac-sim/isaac-launchable/blob/main/isaac-lab/vscode/README.md) instructions inside Visual Studio code. A summary is provided below.
+Once the environment is up, use Isaac Lab as normal. If the Isaac Sim UI is needed (e.g., for policy evaluation), enable streaming as described below.
+
+To run an Isaac Lab sample:
+`/workspace/isaaclab/isaaclab.sh -p "scripts/tutorials/00_sim/create_empty.py" --kit_args="--no-window --enable omni.kit.livestream.webrtc"`
+
+### View the Isaac Sim UI in the browser
+To run an Isaac sample:
 
-Now you can run Isaac Lab as normal, unless you need to see the UI of Isaac Sim (for example, when evaluating a policy)
-To do this:
 1. Add these additional arguments to the Isaac Lab command `--kit_args="--no-window --enable omni.kit.livestream.webrtc"`.
 2. Open a new tab in your browser.
-3. Visit the same address as the Visual Studio Code server, but with a `/viewer` path appended.
+3. Visit the same address as the Visual Studio Code server and append: `/viewer`
 
-Example: 
+#### Example: 
 
 VSCode - `ec2.something.something.amazonaws.com` at port 80
 
 Isaac Sim UI - `ec2.something.something.amazonaws.com/viewer`
 
+### Running Locally or Creating Your Own Launchable
+
+The following instructions cover both local usage and creating a custom Brev Launchable based on this project.
+
+#### Configuring a Custom Brev Launchable
+
+These instructions are how you create a Launchable as linked at the beginning of this README. You can also fork this repo to customize the containers for your own projects and use cases.
 
-### Required Ports
-The following ports need to be opened, for both the Visual Studio container and for Kit App Streaming.
+1. Log in to the [Brev](https://login.brev.nvidia.com/signin) website.
+2. Go to the Launchables category.
+3. Click the **Create Launchable** button.
+4. Choose the "I don't have any code files" option.
+5. Choose "VM Mode - Basic VM with Python installed", then click Next.
+6. On the next page, add a setup script. Under the *Paste Script* tab, add this code:
+```bash
+#!/bin/bash
+git clone https://github.com/isaac-sim/isaac-launchable
+cd isaac-launchable/isaac-lab
+docker compose up -d
+```
+7. Click Next.
+8. Under "Do you want a Jupyter Notebook experience" select "No, I don't want Jupyter".
+9. Select the TCP/UDP ports tab.
+10. Expose the following ports (for Visual Studio Code Server and Kit App Streaming):
 ```
 80
 1024
 47998
 49100
 ```
-If you're creating a custom Launchable, these ports can opened from the Brev interface.
+11. Click Next.
+12. Choose your desired compute. 
+Note: GPUs with RT cores are required for Kit App Streaming. The specs and drivers versions provided will also need to be compatible with [Isaac Sim](https://docs.isaacsim.omniverse.nvidia.com/5.0.0/installation/requirements.html). Unfortunately the available drivers are not exposed on this page currently.
+13. Choose disk storage, then click Next.
+14. Enter a name, then select **Create Launchable**
 
-## Isaac Sim
+Congratulations! You now have a custom launchable.
 
-To run [[email protected]](https://catalog.ngc.nvidia.com/orgs/nvidia/containers/isaac-sim) headless and stream it to the [web-viewer-sample](https://github.com/NVIDIA-Omniverse/web-viewer-sample).
+#### Launching locally
 
-```
-cd isaac-sim
-docker compose up -d
-open $(docker compose logs web-viewer | grep Network | awk '{print $5}')
-```
+This project can also be used to run a containerized version of Isaac Sim and Isaac Lab.
 
-## Isaac Lab
+To use this project locally, you'll need a workstation that meets Isaac Sim's requirements.
 
-To run Isaac Lab:
+#### Starting the stack
 
-```
-cd isaac-lab
-docker compose up -d
-# Open up the VSCode instance in your browser
-open localhost:80 
-
-# From within VSCode, open a terminal and launch Isaac Sim
-isaacsim isaacsim.exp.full.streaming.kit --no-window
-
-# Open another browser window or tab, and visit
-localhost/viewer
-
-# Now run Isaac Lab
-./isaaclab.sh -p "scripts/tutorials/00_sim/create_empty.py" --experience isaacsim.exp.full.streaming.kit --kit_args="--no-window"
-```
-
-To run other Isaac Lab commands, simply append these parameters to the command as shown above.
-```
---experience isaacsim.exp.full.streaming.kit --kit_args="--no-window"
-```
+Simply run `docker compose up -d` using this file: `isaac-lab/docker-compose.yml`.
 
 ## Licensing Terms
 
-By clicking the  "Deploy Launchable" button, you agree to the NVIDIA Isaac Sim Additional Software and Materials License Agreement found here https://www.nvidia.com/en-us/agreements/enterprise-software/isaac-sim-additional-software-and-materials-license/.
+By clicking the "Deploy Launchable" button, you agree to the NVIDIA Isaac Sim Additional Software and Materials License Agreement found here https://www.nvidia.com/en-us/agreements/enterprise-software/isaac-sim-additional-software-and-materials-license/.

isaac-lab/vscode/README.md

@@ -8,10 +8,10 @@ See the [project repo](https://github.com/isaac-sim/isaac-launchable) for more d
 You can run any of the Issac Lab scripts with the streaming Isaac Sim experience with the following command:
 
 ```console
-./isaaclab.sh -p "scripts/tutorials/00_sim/create_empty.py" --kit_args="--no-window --enable omni.kit.livestream.webrtc"
+/workspace/isaaclab/isaaclab.sh -p "scripts/tutorials/00_sim/create_empty.py" --kit_args="--no-window --enable omni.kit.livestream.webrtc"
 ```
 
-Then, in a separate browser window, open `https://{your instance's address}/viewer`.
+Then, in a separate browser window, open `http://{your instance's address}/viewer`.
 
 To run any other Isaac Lab commands, simply append those same arguments as shown above: `--kit_args="--no-window --enable omni.kit.livestream.webrtc"`