Skip to content

Commit 11f327e

Browse files
shanereetzacwrenn53
authored andcommitted
Update internal README with new command
1 parent 0dc7092 commit 11f327e

File tree

3 files changed

+36
-9
lines changed

3 files changed

+36
-9
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,31 @@ The project includes:
1717

1818
Through this project, users can interact with Isaac Sim and Isaac Lab purely from a web browser, with one tab running Visual Studio Code and terminal commands such as headless Isaac Sim instances, and another tab representing the Kit App Streaming and user interface for Isaac Sim.
1919

20+
### Quickstart Guide
21+
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.
22+
23+
1. Click the Deploy Now button below
24+
[![ 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)
25+
26+
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.
27+
3. Scroll down to the TCP/UDP ports section of the Brev instance page.
28+
4. Click the link associated with port 80 - this will take you to Visual Studio Code Server.
29+
5. The default password is `password`. This can be modified.
30+
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.
31+
32+
Now you can run Isaac Lab as normal, unless you need to see the UI of Isaac Sim (for example, when evaluating a policy)
33+
To do this:
34+
1. Add these additional arguments to the Isaac Lab command `--kit_args="--no-window --enable omni.kit.livestream.webrtc"`.
35+
2. Open a new tab in your browser.
36+
3. Visit the same address as the Visual Studio Code server, but with a `/viewer` path appended.
37+
38+
Example:
39+
40+
VSCode - `ec2.something.something.amazonaws.com` at port 80
41+
42+
Isaac Sim UI - `ec2.something.something.amazonaws.com/viewer`
43+
44+
2045
### Required Ports
2146
The following ports need to be opened, for both the Visual Studio container and for Kit App Streaming.
2247
```

isaac-lab/vscode/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
FROM nvcr.io/nvidia/isaac-lab:2.2.0
1616

1717
USER root
18+
ENV OMNI_KIT_ALLOW_ROOT=1
1819

1920
RUN apt update && \
2021
apt install -y \

isaac-lab/vscode/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,28 @@
33
This project provides a simple way to interact with Isaac Lab, and Isaac Sim, either on the cloud or locally.
44
See the [project repo](https://github.com/isaac-sim/isaac-launchable) for more detaild instructions, but below is a quickstart guide.
55

6-
## Running Isaac Sim
6+
## Running Isaac Lab
77

8-
You can run the streaming Isaac Sim application at anytime with the following command:
8+
You can run any of the Issac Lab scripts with the streaming Isaac Sim experience with the following command:
99

1010
```console
11-
isaacsim isaacsim.exp.full.streaming.kit --no-window
11+
./isaaclab.sh -p "scripts/tutorials/00_sim/create_empty.py" --kit_args="--no-window --enable omni.kit.livestream.webrtc"
1212
```
1313

1414
Then, in a separate browser window, open `https://{your instance's address}/viewer`.
1515

16-
For example, if this is run on a local computer: `127.0.0.1/viewer`
17-
If this is run on an AWS instance, the address may be more like:
16+
To run any other Isaac Lab commands, simply append those same arguments as shown above: `--kit_args="--no-window --enable omni.kit.livestream.webrtc"`
1817

19-
## Running Isaac Lab
18+
## Running Isaac Sim
2019

21-
You can run any of the Issac Lab scripts with the streaming Isaac Sim experience with the following command:
20+
You can run the streaming Isaac Sim application at anytime with the following command:
2221

2322
```console
24-
./isaaclab.sh -p "scripts/tutorials/00_sim/create_empty.py" --kit_args="--no-window --enable omni.kit.livestream.webrtc"
23+
/workspace/isaaclab/_isaac_sim/isaac-sim.sh --no-window --enable omni.kit.livestream.webrtc
2524
```
2625

2726
Then, in a separate browser window, open `https://{your instance's address}/viewer`.
2827

29-
To run any other Isaac Lab commands, simply append those same arguments as shown above: `--kit_args="--no-window --enable omni.kit.livestream.webrtc"`
28+
For example, if this is run on a local computer: `127.0.0.1/viewer`
29+
If this is run on an AWS instance, the address may be more like:
30+
`http://ec2-00-00-000-000.compute-1.amazonaws.com/viewer`

0 commit comments

Comments
 (0)