Skip to content
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.

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

Ground plane tutorial correction #1417

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
8 changes: 4 additions & 4 deletions docs/source/setup/installation/binaries_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -388,10 +388,10 @@ top of the repository:

# Option 1: Using the isaaclab.sh executable
# note: this works for both the bundled python and the virtual environment
./isaaclab.sh -p source/standalone/tutorials/00_sim/create_empty.py
./isaaclab.sh -p source/standalone/tutorials/00_sim/create_ground.py

# Option 2: Using python in your virtual environment
python source/standalone/tutorials/00_sim/create_empty.py
python source/standalone/tutorials/00_sim/create_ground.py

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
Expand All @@ -400,10 +400,10 @@ top of the repository:

:: Option 1: Using the isaaclab.bat executable
:: note: this works for both the bundled python and the virtual environment
isaaclab.bat -p source\standalone\tutorials\00_sim\create_empty.py
isaaclab.bat -p source\standalone\tutorials\00_sim\create_ground.py

:: Option 2: Using python in your virtual environment
python source\standalone\tutorials\00_sim\create_empty.py
python source\standalone\tutorials\00_sim\create_ground.py


The above command should launch the simulator and display a window with a black
Expand Down
8 changes: 4 additions & 4 deletions docs/source/setup/installation/pip_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,10 @@ top of the repository:

# Option 1: Using the isaaclab.sh executable
# note: this works for both the bundled python and the virtual environment
./isaaclab.sh -p source/standalone/tutorials/00_sim/create_empty.py
./isaaclab.sh -p source/standalone/tutorials/00_sim/create_ground.py

# Option 2: Using python in your virtual environment
python source/standalone/tutorials/00_sim/create_empty.py
python source/standalone/tutorials/00_sim/create_ground.py

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
Expand All @@ -303,10 +303,10 @@ top of the repository:

:: Option 1: Using the isaaclab.bat executable
:: note: this works for both the bundled python and the virtual environment
isaaclab.bat -p source\standalone\tutorials\00_sim\create_empty.py
isaaclab.bat -p source\standalone\tutorials\00_sim\create_ground.py

:: Option 2: Using python in your virtual environment
python source\standalone\tutorials\00_sim\create_empty.py
python source\standalone\tutorials\00_sim\create_ground.py


The above command should launch the simulator and display a window with a black
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/omni.isaac.lab/config/extension.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]

# Note: Semantic Versioning is used: https://semver.org/
version = "0.27.14"
version = "0.27.15"

# Description
title = "Isaac Lab framework for Robot Learning"
Expand Down
8 changes: 8 additions & 0 deletions source/extensions/omni.isaac.lab/docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Changelog
---------

0.27.15 (2024-11-13)
~~~~~~~~~~~~~~~~~~~~

Fixed
^^^^^

* Created a new script based on the previous tutorial script, implementing the changes to add a black ground plane. Updated the installation documentation to reference the path to this new script.

0.27.14 (2024-10-23)
~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions source/standalone/tutorials/00_sim/create_empty.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"""Rest everything follows."""

from omni.isaac.lab.sim import SimulationCfg, SimulationContext
import omni.isaac.lab.sim as sim_utils


def main():
Expand Down
66 changes: 66 additions & 0 deletions source/standalone/tutorials/00_sim/create_ground.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Copyright (c) 2022-2024, The Isaac Lab Project Developers.
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause

"""This script demonstrates how to create a black ground plane in Isaac Sim.

.. code-block:: bash

# Usage
./isaaclab.sh -p source/standalone/tutorials/00_sim/create_ground.py

"""

"""Launch Isaac Sim Simulator first."""


import argparse

from omni.isaac.lab.app import AppLauncher

# create argparser
parser = argparse.ArgumentParser(description="Tutorial on creating a black ground plane.")
# append AppLauncher cli args
AppLauncher.add_app_launcher_args(parser)
# parse the arguments
args_cli = parser.parse_args()
# launch omniverse app
app_launcher = AppLauncher(args_cli)
simulation_app = app_launcher.app

"""Rest everything follows."""

from omni.isaac.lab.sim import SimulationCfg, SimulationContext
import omni.isaac.lab.sim as sim_utils


def main():
"""Main function."""

# Initialize the simulation context
sim_cfg = SimulationCfg(dt=0.01)
sim = SimulationContext(sim_cfg)
# Set main camera
sim.set_camera_view([2.5, 2.5, 2.5], [0.0, 0.0, 0.0])

# Ground-plane
cfg_ground = sim_utils.GroundPlaneCfg()
cfg_ground.func("/World/defaultGroundPlane", cfg_ground)

# Play the simulator
sim.reset()
# Now we are ready!
print("[INFO]: Setup complete...")

# Simulate physics
while simulation_app.is_running():
# perform step
sim.step()


if __name__ == "__main__":
# run the main function
main()
# close sim app
simulation_app.close()