Skip to content

Commit 8781c2d

Browse files
authored
Document tetrahedralization setup for soft lift tasks (#6967)
# Description Documents the optional tetrahedralization dependencies required by `Isaac-Lift-Soft-Franka` and its camera variant before users launch training from a source checkout. The environment overview now includes both the uv command and the legacy installer command. The note also clarifies that `Isaac-Lift-Cloth-Franka` and its camera variant use surface deformables and do not require these dependencies. The `deformables.py` usage examples now request the tetrahedralization extra, and the Kit-backed uv examples also request the Isaac Sim extra. This documentation change introduces no new dependencies. ## Type of change - Documentation update ## Screenshots Not applicable. ## Validation - `uv run isaaclab -f` - `./isaaclab.sh -p -m py_compile scripts/demos/deformables.py` - `uv run --isolated --extra test -- sphinx-build -W --keep-going -j auto docs tmp/docs-tetrahedralization-pr-pr-build` ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `uv run isaaclab -f` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works (not applicable for this documentation-only change) - [ ] I have added a changelog fragment under `source/<pkg>/changelog.d/` for every touched package (not applicable because no source package changed) - [x] My name already exists in `CONTRIBUTORS.md`
1 parent 2e1225d commit 8781c2d

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

docs/source/overview/environments.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,23 @@ for the lift-cube environment:
209209
* |lift-cube-ik-abs-link|: Franka arm with absolute IK control
210210
* |lift-cube-ik-rel-link|: Franka arm with relative IK control
211211

212+
.. note::
213+
214+
The ``Isaac-Lift-Soft-Franka`` task and its camera variant require automatic tetrahedralization.
215+
The ``Isaac-Lift-Cloth-Franka`` task and its camera variant use surface deformables and do not
216+
require these dependencies.
217+
Install the optional dependencies before running the soft-body tasks from a source checkout:
218+
219+
.. code-block:: bash
220+
221+
uv sync --inexact --extra tetrahedralization
222+
223+
With the legacy installer:
224+
225+
.. code-block:: bash
226+
227+
./isaaclab.sh -i tetrahedralization
228+
212229
.. table::
213230
:widths: 25 30 25 20
214231

scripts/demos/deformables.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@
88
.. code-block:: bash
99
1010
# Usage with default PhysX physics and default kit visualizer.
11-
uv run python scripts/demos/deformables.py
11+
uv run --extra isaacsim --extra tetrahedralization python scripts/demos/deformables.py
1212
1313
# Usage with Newton VBD backend and default kit visualizer.
14-
uv run python scripts/demos/deformables.py --physics newton_vbd
14+
uv run --extra isaacsim --extra tetrahedralization python scripts/demos/deformables.py --physics newton_vbd
15+
16+
# Install the optional dependencies for the legacy launcher.
17+
./isaaclab.sh -i tetrahedralization
1518
1619
# Usage with OvPhysX backend without a visualizer.
1720
./isaaclab.sh -p scripts/demos/deformables.py --physics ovphysx

0 commit comments

Comments
 (0)