Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| `embodichain/lab/scripts/_preview.py`, `preview_joint_control.py` | Shared preview stepping, frontend setup, and simulation-thread joint controls |

Human-facing behavior and usage are documented in
`docs/source/overview/sim/viser_visualization.md`.
`docs/source/overview/sim/visualization/index.rst`.

## Ownership and Data Flow

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/curated.json
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@
],
"documentation": [
{
"docname": "overview/sim/viser_visualization",
"docname": "overview/sim/visualization/viser",
"label": "Browser visualization guide"
}
],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{% set target = pathto(robot_doc_redirects[pagename]) %}
{% set target = pathto(doc_redirects[pagename]) %}
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Robot documentation moved</title>
<title>Documentation moved</title>
<meta name="robots" content="noindex">
<link rel="canonical" href="{{ target | e }}">
<script>
Expand All @@ -14,6 +14,6 @@
</noscript>
</head>
<body>
<p>This page has moved. <a href="{{ target | e }}">Continue to the robot documentation.</a></p>
<p>This page has moved. <a href="{{ target | e }}">Continue to the documentation.</a></p>
</body>
</html>
13 changes: 9 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,13 @@
# Use empty string to use relative paths from the build directory
html_baseurl = ""

# Keep published model URLs working after the vendor/model reorganization.
robot_doc_redirects = {
# Keep published URLs working after documentation reorganizations.
doc_redirects = {
"features/interaction/index": "overview/sim/visualization/index",
"features/interaction/window": "overview/sim/visualization/window",
"features/interaction/gizmo": "overview/sim/visualization/gizmo",
"features/interaction/preview_asset": "guides/preview_asset",
"overview/sim/viser_visualization": "overview/sim/visualization/viser",
"resources/robot/anymal_c": "resources/robot/anybotics/anymal_c",
"resources/robot/microduck": "resources/robot/pollen_robotics/microduck",
"resources/robot/unitree_g1": "resources/robot/unitree/g1",
Expand All @@ -138,7 +143,7 @@
"resources/robot/aloha_mini": "resources/robot/alohamini/aloha_mini",
}
html_additional_pages = {
old_docname: "robot_redirect.html" for old_docname in robot_doc_redirects
old_docname: "doc_redirect.html" for old_docname in doc_redirects
}

# HTML context for better path handling
Expand All @@ -147,7 +152,7 @@
"github_repo": "EmbodiChain",
"github_version": "main",
"doc_path": "docs/source",
"robot_doc_redirects": robot_doc_redirects,
"doc_redirects": doc_redirects,
}

html_theme_options = {
Expand Down
8 changes: 0 additions & 8 deletions docs/source/features/interaction/preview_asset.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/guides/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ embodichain run-task --gym_config config.yaml \
The Viser panel supports environment visibility, camera-frustum selection, RGB
preview, and overlay visibility. For supported object types, programmatic
configuration, remote access, and performance details, see
:doc:`../overview/sim/viser_visualization`.
{doc}`../overview/sim/visualization/viser`.

### Preview Mode

Expand Down
4 changes: 2 additions & 2 deletions docs/source/guides/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ uses this step-synchronized mode by default when neither the configuration nor

Keep `viser_server.host` on loopback for remote workers and use SSH port
forwarding unless the service is behind an authenticated gateway. See
[Browser visualization with Viser](../overview/sim/viser_visualization.md) for
[Browser visualization with Viser](../overview/sim/visualization/viser.md) for
the full schema, supported scene content, and deformable-object behavior.

### Reusable Physical Environments and Runnable Deployments
Expand Down Expand Up @@ -563,6 +563,6 @@ This is automatically converted to a `SceneEntityCfg` object at runtime.

- [Custom Functors Guide](custom_functors.md) — How to write observation, reward, event, and action functors
- [Embodied Environments](../overview/gym/env.md) — Full environment configuration reference
- [Browser Visualization](../overview/sim/viser_visualization.md) — Viser configuration and runtime behavior
- [Browser Visualization](../overview/sim/visualization/viser.md) — Viser configuration and runtime behavior
- [Tutorial: Modular Environment](../tutorial/modular_env.rst) — Complete example using config-driven setup
- [Tutorial: RL Training](../tutorial/rl.rst) — RL training configuration walkthrough
2 changes: 1 addition & 1 deletion docs/source/guides/preview_asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ embodichain preview-asset \

Use `--viser-host`, `--viser-port`, `--viser-fps`, and the other standard
`--viser-*` options to configure the browser server and update rates. See
{doc}`Viser browser visualization </overview/sim/viser_visualization>` for the
{doc}`Viser browser visualization </overview/sim/visualization/viser>` for the
complete backend reference and remote-access guidance.

## Asset Type and Placement
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guides/run_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ created by `record_camera_data` under **Record cameras** from configured
observation sensors under **Sensor cameras**.
Limit the published batch with `--viser-env-ids`, and tune scene, image, or
soft-body publication rates with the corresponding `--viser-*-fps` options. See
{doc}`/overview/sim/viser_visualization` for browser controls and remote-access
{doc}`/overview/sim/visualization/viser` for browser controls and remote-access
details.

## Run and record
Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ Table of Contents
features/neural_dynamics.md
features/generative_sim/index*
features/workspace_analyzer/index*
features/interaction/index*
features/toolkits/index*

.. toctree::
Expand Down
6 changes: 3 additions & 3 deletions docs/source/overview/sim/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,8 +376,8 @@ Choosing where to start
- :doc:`sim_assets` and the object pages underneath it
* - Add RGB, depth, stereo, segmentation, or contact observations
- :doc:`sensors/index`
* - Inspect a headless or remote scene in a browser
- :doc:`viser_visualization`
* - Inspect or manipulate a scene through a native window or browser
- :doc:`visualization/index`
* - Tune native rendering, DLSS, or frame timing
- :doc:`sim_manager/rendering/index`
* - Solve kinematics or generate a timed robot trajectory
Expand Down Expand Up @@ -416,6 +416,6 @@ See Also
sim_manager.md
sim_assets.md
sensors/index
viser_visualization.md
visualization/index
motion/index
atomic_actions/index
8 changes: 4 additions & 4 deletions docs/source/overview/sim/sim_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ The browser supports rigid objects and groups, robot and articulation links,
cloth, soft bodies, camera frustums, low-frequency RGB preview, overlays, and a
1 m ground grid. For configuration, performance behavior, deformable-object
limitations, remote access, and troubleshooting, see
{doc}`viser_visualization`.
{doc}`visualization/viser`.

## Native point-cloud visualization

Expand All @@ -205,7 +205,7 @@ point_cloud = sim.visualize_point_cloud(

The returned native point-cloud handle can be queried or modified with the
DexSim point-cloud API. This method targets the native window; use the
browser-overlay APIs documented in {doc}`viser_visualization` for Viser.
browser-overlay APIs documented in {doc}`visualization/viser` for Viser.
See {doc}`/tutorial/point_cloud_visualization` for a runnable color-and-position
verification example.

Expand Down Expand Up @@ -314,5 +314,5 @@ For more methods and details, see the {doc}`SimulationManager API </api_referenc
### Related Documentation

- {doc}`Basic scene creation </tutorial/create_scene>`
- {doc}`Interactive Gizmos </features/interaction/gizmo>`
- {doc}`Viser browser visualization <viser_visualization>`
- {doc}`Interactive Gizmos </overview/sim/visualization/gizmo>`
- {doc}`Viser browser visualization <visualization/viser>`
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ factory-created controller and does not create or update a duplicate.

For the complete robot setup and IK walkthrough, continue with the
{doc}`Gizmo tutorial </tutorial/gizmo>`. See
{doc}`Viser browser visualization </overview/sim/viser_visualization>` for
{doc}`Viser browser visualization <viser>` for
server configuration and remote-access guidance.
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
Interactive Simulation
======================
.. _interactive-simulation:

Interactive Simulation covers the frontends and controls used to inspect or
manipulate a running simulation. Task-specific commands such as asset preview,
Visualization and Interaction
=============================

This section covers the visualization frontends and controls used to inspect
or manipulate a running simulation. Task-specific commands such as asset preview,
workspace visualization, and grasp annotation remain in their own guides or
feature sections.

Interaction Frontends
---------------------
.. _interaction-frontends:

Visualization Frontends
-----------------------

.. list-table::
:header-rows: 1
Expand All @@ -23,7 +27,7 @@ Interaction Frontends
* - Viser browser
- Headless or remote scene inspection, camera previews, environment
visibility, overlays, and trusted browser controls.
- :doc:`Viser browser visualization </overview/sim/viser_visualization>`
- :doc:`Viser browser visualization <viser>`

The native window and Viser are mutually exclusive visualization frontends.
Both can expose the same registered Gizmo targets.
Expand All @@ -50,4 +54,5 @@ Related Workflows
:maxdepth: 2

Native window interaction <window.md>
Viser browser visualization <viser.md>
Interactive Gizmos <gizmo.md>
Original file line number Diff line number Diff line change
Expand Up @@ -314,10 +314,10 @@ Viser port behind an authenticated gateway.

## Related pages

- {doc}`sim_manager`
- {doc}`sim_assets`
- {doc}`sensors/index`
- {doc}`/features/interaction/gizmo`
- {doc}`../sim_manager`
- {doc}`../sim_assets`
- {doc}`../sensors/index`
- {doc}`gizmo`
- {doc}`/guides/preview_asset`
- {doc}`/tutorial/create_scene`
- {doc}`/tutorial/sensor`
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The native window and the Viser backend are mutually exclusive;
native window while Viser is enabled.
Likewise, `SimulationManager.start_visualization()` rejects Viser startup while
the native window is open.
See {doc}`Viser browser visualization </overview/sim/viser_visualization>` for
See {doc}`Viser browser visualization <viser>` for
the headless browser frontend.

## Default Window Controls
Expand Down Expand Up @@ -111,7 +111,7 @@ tutorial enables this option after preparing its initial joint pose.
The entity gizmo is native-window only. The Viser backend offers an analogous
**click-to-pick** flow (an *Enable click-to-pick Gizmo* checkbox instead of the
**G** hotkey, since browsers do not expose keyboard events); see
:doc:`tutorial/gizmo` for details.
{doc}`Gizmo tutorial </tutorial/gizmo>` for details.

## Customizing Window Events

Expand Down
4 changes: 2 additions & 2 deletions docs/source/quick_start/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ and forward the port:
ssh -N -L 8080:127.0.0.1:8080 user@worker-host
```

See [Browser visualization with Viser](../overview/sim/viser_visualization.md)
See [Browser visualization with Viser](../overview/sim/visualization/viser.md)
for supported objects, camera preview, update-rate options, and remote-access
guidance.

Expand All @@ -380,5 +380,5 @@ Press `Ctrl+C` to stop; the script cleans up the simulation on exit.

- [Quick Start Tutorial](../tutorial/index.rst)
- [Simulation Manager](../overview/sim/sim_manager.md)
- [Browser visualization with Viser](../overview/sim/viser_visualization.md)
- [Browser visualization with Viser](../overview/sim/visualization/viser.md)
- [Build documentation](docs.md)
2 changes: 1 addition & 1 deletion docs/source/tutorial/create_cloth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,6 @@ the source triangles, so its topology matches the simulated cloth surface.
Deformable updates are sampled separately from rigid-body poses; adjust
``--viser-soft-body-fps`` to balance smoothness and browser/upload cost.

See :doc:`/overview/sim/viser_visualization` for details.
See :doc:`/overview/sim/visualization/viser` for details.

Now that we have a basic understanding of how to create a cloth scene, let's move on to more advanced topics.
4 changes: 2 additions & 2 deletions docs/source/tutorial/create_scene.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Use ``--viser-env-ids`` for selected parallel environments and
--viser-env-ids 0 2 \
--viser-fps 15

See :doc:`/overview/sim/viser_visualization` for the complete object support
See :doc:`/overview/sim/visualization/viser` for the complete object support
matrix, server settings, telemetry, and remote-access guidance.

Running the simulation
Expand Down Expand Up @@ -146,6 +146,6 @@ Next Steps
- :doc:`create_softbody` — Add deformable bodies to your scene
- :doc:`robot` — Load and control a robot
- :doc:`sensor` — Add cameras and capture sensor data
- :doc:`/overview/sim/viser_visualization` — Configure browser visualization
- :doc:`/overview/sim/visualization/viser` — Configure browser visualization
- :doc:`basic_env` — Create your first Gymnasium environment
- :doc:`/overview/sim/sim_manager` — Full SimulationManager API reference
2 changes: 1 addition & 1 deletion docs/source/tutorial/create_softbody.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ render mesh are intentionally simplified. Lower
``--viser-soft-body-fps`` when publishing large soft bodies or several
environments.

See :doc:`/overview/sim/viser_visualization` for details.
See :doc:`/overview/sim/visualization/viser` for details.

Now that we have a basic understanding of how to create a soft-body scene, let's move on to more advanced topics.
2 changes: 1 addition & 1 deletion docs/source/tutorial/gizmo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ DexSim owns native entity and robot IK controllers; EmbodiChain keeps only the
robot control-part adapter, Viser commands, and controller lifecycle management.

For the cross-frontend capability summary, supported targets, lifecycle rules,
and security boundary, see :doc:`/features/interaction/gizmo`.
and security boundary, see :doc:`/overview/sim/visualization/gizmo`.

The Code
~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial/rigid_object_group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ Use ``--viser`` to publish every constituent object in the group to the browser:

Each group member has its own pose and browser node. Shared geometry remains
batched by the Viser backend. See
:doc:`/overview/sim/viser_visualization` for server and environment-selection
:doc:`/overview/sim/visualization/viser` for server and environment-selection
options.
2 changes: 1 addition & 1 deletion docs/source/tutorial/sensor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,6 @@ After completing this tutorial, you can explore:
- Using other sensor types (e.g., stereo cameras, force sensors)
- Recording sensor data for offline analysis
- Integrating sensor feedback into robot control or learning algorithms
- Configuring :doc:`/overview/sim/viser_visualization` for remote camera inspection
- Configuring :doc:`/overview/sim/visualization/viser` for remote camera inspection

This tutorial provides a foundation for integrating perception into robotic simulation scenarios with SimulationManager.
Loading