Skip to content

docs: document introductory example prerequisites #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KhushiSharma22 merged 1 commit into from
Oct 5, 2026
Merged

docs: document introductory example prerequisites #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ Adjust asset slugs (`the-robot-studio/so101`, `unitree/go2`, …) to match your
catalog. Some examples need optional extras (e.g. `cyberwave[camera]`, `cyberwave[ml]`,
`cyberwave[zenoh]`) — see the [installation docs](https://docs.cyberwave.com/overview).

## Introductory example prerequisites

All four introductory examples require the base `cyberwave` package and a
`CYBERWAVE_API_KEY`. They connect to the Cyberwave backend, so none of them
works completely offline.

| Script | Required extras | Backend / API access | Simulation support | Physical hardware |
| --- | --- | --- | --- | --- |
| [quickstart.py](quickstart.py) | None | API key and Cyberwave backend required | Uses `cw.affect("simulation")` for the Go2 locomotion portion | Not required for scene editing or simulated locomotion; the earlier joint command uses the default live runtime and depends on a connected twin/edge driver for live actuation |
| [compact.py](compact.py) | None | API key and Cyberwave backend required | Does not explicitly select simulation; uses the client's default live runtime | No hardware is hard-coded, but meaningful live joint state requires a connected twin/edge source |
| [joints.py](joints.py) | None | API key and Cyberwave backend required | Does not explicitly select simulation; uses the client's default live runtime | Live joint reads and writes require a connected twin/edge driver |
| [locomotion.py](locomotion.py) | None | API key and Cyberwave backend required | Explicitly selects simulation with `cw.affect("simulation")` | No physical robot required for the simulation path |

## Getting started

| Script | Description |
Expand Down
Loading