Skip to content

Commit b667cc4

Browse files
committed
Revise documentation structure and workflows
1 parent 3d1be2c commit b667cc4

26 files changed

Lines changed: 1364 additions & 1331 deletions

docs/docs/getting-started/download-assets.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/docs/getting-started/installation.md

Lines changed: 107 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,116 @@
22
sidebar_position: 1
33
---
44

5-
# Installation
5+
# Install Teleopit
66

7-
Teleopit supports multiple installation profiles depending on your use case.
7+
Install only the parts you need. All commands below run from the repository
8+
root and require Python 3.10 or newer.
89

9-
## Prerequisites
10-
11-
- Python 3.10+
12-
- [Conda](https://docs.conda.io/) (recommended)
10+
## 1. Get the Code
1311

1412
```bash
15-
conda create -n teleopit python=3.10
16-
conda activate teleopit
13+
git clone https://github.com/BotRunner64/Teleopit.git
14+
cd Teleopit
1715
```
1816

19-
## Install Profiles
17+
You only need Git submodules for a physical G1 or optional LinkerHand control;
18+
those steps appear later on this page.
19+
20+
## 2. Create a Python Environment
21+
22+
Choose one environment tool. Do not run all three sections.
2023

21-
### Inference Only (sim2sim)
24+
### uv
2225

2326
```bash
24-
pip install -e .
27+
uv venv --python 3.10
28+
source .venv/bin/activate
2529
```
2630

27-
This is sufficient for offline BVH playback and MuJoCo simulation.
31+
When this page shows `pip install`, you may use `uv pip install` instead.
2832

29-
### Training
33+
### pip and venv
3034

3135
```bash
32-
pip install -e '.[train]'
36+
python3.10 -m venv .venv
37+
source .venv/bin/activate
38+
python -m pip install --upgrade pip
3339
```
3440

35-
Adds `rsl-rl-lib`, `mjlab`, `wandb`, `swanlab`, and training dependencies.
41+
### Conda
3642

37-
### Sim2Real (Hardware Deployment)
43+
```bash
44+
conda create -n teleopit python=3.10
45+
conda activate teleopit
46+
```
47+
48+
Conda creates the environment; use `pip install` inside that environment to
49+
install Teleopit.
50+
51+
## 3. Install the Profile You Need
52+
53+
Each extra includes the base Teleopit package. Start with the row matching your
54+
goal; you can install another extra later in the same environment.
55+
56+
| Goal | Install command | What it adds |
57+
|------|-----------------|--------------|
58+
| Run a motion controller in MuJoCo | `pip install -e .` | Core inference, GMR, MuJoCo and ONNX Runtime |
59+
| Use Pico in simulation or on G1 | `pip install -e '.[pico4]'` | Pico receiver plus the sim2real runtime |
60+
| Replay BVH on a physical G1 without Pico | `pip install -e '.[sim2real]'` | G1 runtime and OpenCV |
61+
| Train a controller | `pip install -e '.[train]'` | mjlab, RSL-RL and experiment loggers |
62+
| Record Pico sim2real episodes | `pip install -e '.[recording]'` | Pico runtime and MP4 writing |
63+
| Review saved recordings | `pip install -e '.[review]'` | OpenCV and the MuJoCo/Viser reviewer |
64+
| Use OpenNeck with Pico | `pip install -e '.[openneck]'` | Pico runtime and the OpenNeck driver |
65+
| Run the test suite | `pip install -e '.[dev]'` | pytest and coverage tools |
66+
67+
## 4. Download the Matching Assets
68+
69+
The Python package does not contain robot meshes, policies or motion datasets.
70+
Install the default ModelScope downloader once:
3871

3972
```bash
40-
pip install -e '.[sim2real]'
73+
pip install modelscope
4174
```
4275

43-
Adds `opencv-python`. You also need to initialize submodules and build/install the C++ `g1_bridge_sdk` bridge:
76+
Then download the bundle for your goal:
77+
78+
| Goal | Command |
79+
|------|---------|
80+
| Simulation, Pico VR or G1 inference | `python scripts/setup/download_assets.py --only robots gmr ckpt bvh` |
81+
| Training from the distributed datasets | `python scripts/setup/download_assets.py --only robots data` |
82+
| Everything | `python scripts/setup/download_assets.py` |
83+
84+
Use HuggingFace instead of ModelScope when needed:
4485

4586
```bash
46-
git submodule update --init --recursive
47-
bash scripts/setup/setup_g1_bridge.sh
87+
python scripts/setup/download_assets.py \
88+
--source huggingface \
89+
--only robots gmr ckpt bvh
4890
```
4991

50-
See [G1 Bridge SDK](../reference/g1-bridge-sdk) for details.
92+
The inference bundle creates `track.onnx`, the canonical G1 model, GMR files and
93+
a sample BVH under their expected project paths. See
94+
[Asset Reference](../reference/assets) for the complete inventory and asset
95+
group mapping.
5196

52-
### Pico 4 VR
97+
## 5. Additional Setup for a Physical G1
98+
99+
Build the C++ DDS bridge on the computer that will run Teleopit:
53100

54101
```bash
55-
pip install -e '.[pico4]'
102+
git submodule update --init --recursive
103+
bash scripts/setup/setup_g1_bridge.sh
56104
```
57105

58-
Teleopit uses the in-process `pico_bridge.PicoBridge` receiver for Pico tracking.
59-
Teleopit targets pico-bridge 0.2.1 and its `pico_native` tracking semantics.
60-
The receiver can run on a workstation PC or the robot onboard computer.
61-
See [Pico Sim2Sim](../tutorials/pico-sim2sim) and
62-
[Pico Sim2Real](../tutorials/pico-sim2real) for the full setup guides.
106+
The bridge is required for both Pico and BVH control on a real G1. See
107+
[G1 Bridge SDK](../reference/g1-bridge-sdk) if the build or robot connection
108+
fails.
109+
110+
## 6. Optional Hardware
63111

64-
Optional LinkerHand control for Pico sim2real uses local third-party packages.
65-
Install those packages directly after initializing the submodules:
112+
### LinkerHand L6 or O6
113+
114+
Only install these local packages when `hands.enabled=true`:
66115

67116
```bash
68117
git submodule update --init --recursive
@@ -71,54 +120,54 @@ pip install -e third_party/somehand
71120
bash scripts/setup/download_somehand_assets.sh
72121
```
73122

74-
These packages are only required when `hands.enabled=true`.
123+
### OpenNeck
75124

76-
Optional OpenNeck active-vision control for Pico sim2real uses the latest
77-
OpenNeck angle-control package:
125+
The `openneck` extra already includes the Pico profile. Calibrate the device
126+
before enabling it:
78127

79128
```bash
80129
pip install -e '.[openneck]'
130+
openneck calibrate
81131
```
82132

83-
This extra includes the Pico stack and is only required when `neck.enabled=true`.
84-
OpenNeck 0.2.0 calibration files use `*_center_step`, `*_min_step`,
85-
`*_max_step`, and `*_step_sign`; the previous normalized configuration format
86-
is unsupported. Run `openneck calibrate` to create a current calibration file.
133+
Teleopit uses the OpenNeck angle API. Old normalized calibration fields are not
134+
supported.
135+
136+
### RealSense Recording or Preview
87137

88-
### Sim2Real Recording
138+
Install `pyrealsense2` separately when a RealSense camera is enabled. On Arm
139+
machines, use conda-forge:
89140

90141
```bash
91-
pip install -e '.[recording]'
142+
conda install -c conda-forge pyrealsense2
92143
```
93144

94-
Adds the Pico sim2real stack plus the video dependencies used by
95-
`sim2real_record.yaml`. RealSense Python bindings are platform-specific: install
96-
`pyrealsense2` manually in the active environment when using
97-
`input.video.source=realsense`. On Arm machines, use conda-forge rather than the
98-
pip package:
145+
Pico body tracking itself does not require RealSense.
146+
147+
## 7. Verify the Environment
148+
149+
Run the core import check:
99150

100151
```bash
101-
conda install -c conda-forge pyrealsense2
152+
python -c "import teleopit; print('teleopit OK')"
102153
```
103154

104-
### Recording Review
155+
If you installed Pico or training dependencies, run the matching check:
105156

106157
```bash
107-
pip install -e '.[review]'
158+
python -c "from pico_bridge import PicoBridge; print('Pico OK')"
159+
python -c "import train_mimic.tasks; print('training OK')"
108160
```
109161

110-
Adds the OpenCV and MuJoCo/Viser dependencies used by the read-only synchronized
111-
sim2real recording reviewer. The review extra does not install Pico, RealSense,
112-
or G1 control dependencies.
113-
114-
## Verify Installation
162+
For an inference profile with the `robots gmr ckpt bvh` assets, finish with one
163+
sample simulation:
115164

116165
```bash
117-
python -c "import teleopit; print('teleopit OK')"
118-
python -c "import train_mimic.tasks; print('training OK')" # if training installed
166+
python scripts/run/run_sim.py \
167+
controller.policy_path=track.onnx \
168+
input.bvh_file=data/sample_bvh/aiming1_subject1.bvh
119169
```
120170

121-
## Next Steps
122-
123-
- [Download Assets](download-assets) - Download models and data
124-
- [Quick Start](quick-start) - Run your first simulation
171+
The installation is ready when a MuJoCo window opens and the simulated G1
172+
follows the sample motion. Close the window to stop, then continue with one of
173+
the four task-based tutorials.

docs/docs/getting-started/quick-start.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

0 commit comments

Comments
 (0)