Skip to content

Commit

Permalink
Fixes docs on running tutorials with cameras (isaac-sim#1116)
Browse files Browse the repository at this point in the history
# Description

Adds the `enable_cameras` flag to tutorials requiring cameras.

## Type of change

- Bug fix (non-breaking change which fixes an issue)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [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
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
  • Loading branch information
Dhoeller19 authored Oct 3, 2024
1 parent 32ea57e commit 087535b
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/how-to/save_camera_output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To run the accompanying script, execute the following command:
.. code-block:: bash
# Usage with saving and drawing
./isaaclab.sh -p source/standalone/tutorials/04_sensors/run_usd_camera.py --save --draw
./isaaclab.sh -p source/standalone/tutorials/04_sensors/run_usd_camera.py --save --draw --enable_cameras
# Usage with saving only in headless mode
./isaaclab.sh -p source/standalone/tutorials/04_sensors/run_usd_camera.py --save --headless --enable_cameras
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/04_sensors/add_sensors_on_robot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Now that we have gone through the code, let's run the script and see the result:

.. code-block:: bash
./isaaclab.sh -p source/standalone/tutorials/04_sensors/add_sensors_on_robot.py --num_envs 2
./isaaclab.sh -p source/standalone/tutorials/04_sensors/add_sensors_on_robot.py --num_envs 2 --enable_cameras
This command should open a stage with a ground plane, lights, and two quadrupedal robots.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
.. code-block:: bash
# Usage
./isaaclab.sh -p source/standalone/tutorials/04_sensors/add_sensors_on_robot.py
./isaaclab.sh -p source/standalone/tutorials/04_sensors/add_sensors_on_robot.py --enable_cameras
"""

Expand Down
4 changes: 2 additions & 2 deletions source/standalone/tutorials/04_sensors/run_usd_camera.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
.. code-block:: bash
# Usage with GUI
./isaaclab.sh -p source/standalone/tutorials/04_sensors/run_usd_camera.py
./isaaclab.sh -p source/standalone/tutorials/04_sensors/run_usd_camera.py --enable_cameras
# Usage with headless
./isaaclab.sh -p source/standalone/tutorials/04_sensors/run_usd_camera.py --headless --enable_cameras
Expand Down Expand Up @@ -53,7 +53,7 @@
AppLauncher.add_app_launcher_args(parser)
# parse the arguments
args_cli = parser.parse_args()
args_cli.enable_cameras = True

# launch omniverse app
app_launcher = AppLauncher(args_cli)
simulation_app = app_launcher.app
Expand Down

0 comments on commit 087535b

Please sign in to comment.