Skip to content

Commit c0eb55c

Browse files
authored
Updates package licenses, CPU Governor setting in docs, and flaky tests (#3778)
# Description There were some recent updates to a couple of our dependency packages that have updated their licenses. Updating our license checker exceptions to match with the new updated licenses for these packages. Additionally, adds a note in the simulation performance documentation for CPU governor setting to improve performance. Also, updates a few unit tests to mark as flaky as we've shown in recent CI runs. ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Bug fix (non-breaking change which fixes an issue) - Documentation update ## 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 `./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 - [ ] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task -->
1 parent 1103a0f commit c0eb55c

File tree

5 files changed

+24
-32
lines changed

5 files changed

+24
-32
lines changed

.github/workflows/license-exceptions.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -195,13 +195,13 @@
195195
},
196196
{
197197
"package": "cmeel-boost",
198-
"license": "UNKNOWN",
198+
"license": "BSL-1.0",
199199
"comment": "BSL"
200200
},
201201
{
202202
"package": "cmeel-console-bridge",
203-
"license": "UNKNOWN",
204-
"comment": "BSD"
203+
"license": "Zlib",
204+
"comment": "ZLIBL"
205205
},
206206
{
207207
"package": "cmeel-octomap",
@@ -215,7 +215,7 @@
215215
},
216216
{
217217
"package": "cmeel-tinyxml",
218-
"license": "UNKNOWN",
218+
"license": "Zlib",
219219
"comment": "ZLIBL"
220220
},
221221
{
@@ -225,7 +225,7 @@
225225
},
226226
{
227227
"package": "cmeel-zlib",
228-
"license": "UNKNOWN",
228+
"license": "Zlib",
229229
"comment": "ZLIBL"
230230
},
231231
{
@@ -293,7 +293,7 @@
293293
},
294294
{
295295
"package": "filelock",
296-
"license": "The Unlicense (Unlicense)",
296+
"license": "Unlicense",
297297
"comment": "no condition"
298298
},
299299
{

docs/source/how-to/simulation_performance.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,21 @@ collision detection will fall back to CPU. Collisions with particles and deforma
4343
Suitable workarounds include switching to a bounding cube approximation, or using a static triangle mesh collider
4444
if the geometry is not part of a dynamic rigid body.
4545

46+
CPU Governor Settings on Linux
47+
------------------------------
48+
49+
CPU governors dictate the operating clock frequency range and scaling of the CPU. This can be a limiting factor for Isaac Sim performance. For maximum performance, the CPU governor should be set to ``performance``. To modify the CPU governor, run the following commands:
50+
51+
.. code-block:: bash
52+
53+
sudo apt-get install linux-tools-common
54+
cpupower frequency-info # Check available governors
55+
sudo cpupower frequency-set -g performance # Set governor with root permissions
56+
57+
.. note::
58+
59+
Not all governors are available on all systems. Governors enabling higher clock speed are typically more performance-centric and will yield better performance for Isaac Sim.
60+
4661
Additional Performance Guides
4762
-----------------------------
4863

docs/source/refs/troubleshooting.rst

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -78,32 +78,6 @@ For instance, to run a standalone script with verbose logging, you can use the f
7878
For more fine-grained control, you can modify the logging channels through the ``omni.log`` module.
7979
For more information, please refer to its `documentation <https://docs.omniverse.nvidia.com/kit/docs/carbonite/latest/docs/omni.log/Logging.html>`__.
8080

81-
Using CPU Scaling Governor for performance
82-
------------------------------------------
83-
84-
By default on many systems, the CPU frequency governor is set to
85-
“powersave” mode, which sets the CPU to lowest static frequency. To
86-
increase the maximum performance, we recommend setting the CPU frequency
87-
governor to “performance” mode. For more details, please check the the
88-
link
89-
`here <https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/power_management_guide/cpufreq_governors>`__.
90-
91-
.. warning::
92-
We advice not to set the governor to “performance” mode on a system with poor
93-
cooling (such as laptops), since it may cause the system to overheat.
94-
95-
- To view existing ``scaling_governor`` value per CPU:
96-
97-
.. code:: bash
98-
99-
cat /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
100-
101-
- To change the governor to “performance” mode for each CPU:
102-
103-
.. code:: bash
104-
105-
echo performance | sudo tee /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
106-
10781

10882
Observing long load times at the start of the simulation
10983
--------------------------------------------------------

source/isaaclab/test/assets/test_rigid_object.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import isaacsim.core.utils.prims as prim_utils
2424
import pytest
25+
from flaky import flaky
2526

2627
import isaaclab.sim as sim_utils
2728
from isaaclab.assets import RigidObject, RigidObjectCfg
@@ -857,6 +858,7 @@ def test_gravity_vec_w(num_cubes, device, gravity_enabled):
857858
@pytest.mark.parametrize("device", ["cuda:0", "cpu"])
858859
@pytest.mark.parametrize("with_offset", [True, False])
859860
@pytest.mark.isaacsim_ci
861+
@flaky(max_runs=3, min_passes=1)
860862
def test_body_root_state_properties(num_cubes, device, with_offset):
861863
"""Test the root_com_state_w, root_link_state_w, body_com_state_w, and body_link_state_w properties."""
862864
with build_simulation_context(device=device, gravity_enabled=False, auto_add_lighting=True) as sim:

source/isaaclab/test/sensors/test_contact_sensor.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ def setup_simulation():
223223

224224

225225
@pytest.mark.parametrize("disable_contact_processing", [True, False])
226+
@flaky(max_runs=3, min_passes=1)
226227
def test_cube_contact_time(setup_simulation, disable_contact_processing):
227228
"""Checks contact sensor values for contact time and air time for a cube collision primitive."""
228229
# check for both contact processing enabled and disabled

0 commit comments

Comments
 (0)