Skip to content

Commit 38dc7a6

Browse files
committed
docs: improve formatting and wording in installation and yaml docs
1 parent 63136fe commit 38dc7a6

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

InterDataEngine-docs/config/yaml.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,24 @@ A task YAML file defines all components needed for a simulation episode: environ
1313

1414
## World Settings
1515

16-
Global simulation settings are defined in `workflows/simbox/core/configs/world.yaml`:
16+
Global simulation settings are defined in the YAML files under `configs/simbox`:
1717

1818
```yaml
19-
world:
20-
physics_dt: 1/30
21-
rendering_dt: 1/30
22-
stage_units_in_meters: 1.0
19+
simulator:
20+
physics_dt: 1/30 # Physics update rate
21+
rendering_dt: 1/30 # Render update rate
22+
stage_units_in_meters: 1.0 # Stage unit scale
23+
headless: True # Run without GUI; set to False for visual debugging
24+
anti_aliasing: 0 # Anti-aliasing level
2325
```
2426
2527
| Field | Description |
2628
|-------|-------------|
27-
| `physics_dt` | Physics simulation timestep (seconds) |
28-
| `rendering_dt` | Rendering timestep (seconds) |
29-
| `stage_units_in_meters` | Unit scale for the USD stage |
29+
| `physics_dt` | Physics simulation time step (in seconds). |
30+
| `rendering_dt` | Rendering time step (in seconds). |
31+
| `stage_units_in_meters` | Unit scale used for the USD stage. |
32+
| `headless` | Run without GUI; set to `False` for visual debugging. |
33+
| `anti_aliasing` | Anti-aliasing level (0 = disabled). |
3034

3135
## Task Basic Configuration
3236

InterDataEngine-docs/guides/installation.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Before installing InternDataEngine, ensure the following requirements are met:
2020
## Step 1: Clone the Repository
2121

2222
```bash
23-
git clone https://github.com/your-org/InternDataEngine.git
24-
cd YOUR_PATH_TO_DATA_ENGINE
23+
git clone https://github.com/InternRobotics/InternDataEngine.git
24+
cd InternDataEngine
2525
```
2626

2727
## Step 2: Prepare Isaac Sim
@@ -42,9 +42,6 @@ InternDataAssets/
4242
```
4343

4444
### 3.1 Scene Assets
45-
46-
> **Tip**: The full asset collection is large. Download selectively based on your needs.
47-
4845
**Required assets** (needed for all tasks):
4946

5047
- `background_textures`, `envmap_lib`, `floor_textures`, `table_textures` — Domain Randomization materials
@@ -78,10 +75,15 @@ bash scripts/download_assets.sh [OPTIONS]
7875
# Minimum assets + CuRobo + panda_drake
7976
bash scripts/download_assets.sh --min --with-curobo --with-drake
8077

81-
# Full download
78+
# Full download (~200GB)
8279
bash scripts/download_assets.sh --full --with-curobo --with-drake
8380
```
8481

82+
<div class="custom-tip">
83+
<p class="custom-tip-title">Hint</p>
84+
<p class="custom-tip-content">The full asset collection is large, so download selectively based on your needs. Because the background, floor, and table textures contain many images for domain randomization, if your download speed is slow or disk space is limited, you can download only a small subset (e.g., 10+ images per directory) for debugging.</p>
85+
</div>
86+
8587
### 3.2 CuRobo
8688

8789
If you already have CuRobo installed and don't need to download it via the script above, simply merge the contents of [`curobo/src/curobo/content`](https://huggingface.co/datasets/InternRobotics/InternData-A1/tree/main/InternDataAssets/curobo/src/curobo/content) from HuggingFace into your local `YOUR_CUROBO_PATH/src/curobo/content` (contains robot URDFs and CuRobo configuration files).
@@ -92,7 +94,7 @@ If CuRobo is not yet installed, you can also get the source from [NVlabs/curobo]
9294
## Step 4: Create Symlinks
9395

9496
```bash
95-
cd YOUR_PATH_TO_DATA_ENGINE/workflows/simbox
97+
cd InternDataEngine/workflows/simbox
9698
ln -s YOUR_PATH_TO_ASSETS assets
9799
ln -s YOUR_PATH_TO_CUROBO curobo
98100
ln -s YOUR_PATH_TO_PANDA_DRAKE panda_drake
@@ -103,7 +105,7 @@ ln -s YOUR_PATH_TO_PANDA_DRAKE panda_drake
103105
### Option A: Using Isaac Sim's Built-in Python
104106

105107
```bash
106-
cd YOUR_PATH_TO_DATA_ENGINE
108+
cd InternDataEngine
107109
YOUR_PATH_TO_ISAACSIM/python.sh -m pip install --upgrade pip
108110
YOUR_PATH_TO_ISAACSIM/python.sh -m pip install -r requirements.txt
109111
```
@@ -114,6 +116,7 @@ YOUR_PATH_TO_ISAACSIM/python.sh -m pip install -r requirements.txt
114116
conda create -n banana python=3.10
115117
conda activate banana
116118
source YOUR_PATH_TO_ISAACSIM/setup_conda_env.sh
119+
cd InternDataEngine
117120
pip install --upgrade pip
118121
pip install -r requirements.txt
119122
```
@@ -125,7 +128,7 @@ pip install -r requirements.txt
125128
Refer to the [CuRobo installation docs](https://curobo.org/get_started/1_install_instructions.html), specifically the **Install for use in Isaac Sim** section, then run:
126129

127130
```bash
128-
cd YOUR_PATH_TO_DATA_ENGINE/workflows/simbox/curobo
131+
cd InternDataEngine/workflows/simbox/curobo
129132
YOUR_PATH_TO_ISAACSIM/python.sh -m pip install -e .[isaacsim] --no-build-isolation
130133
```
131134

0 commit comments

Comments
 (0)