Skip to content

Commit 287832e

Browse files
committed
Make sure sup-components that live under source/isaaclab/ are called "sub-packages", not extras or anything else
1 parent 91e2733 commit 287832e

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

docs/source/setup/installation/include/src_build_isaaclab.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ Installation
6060
6161
isaaclab.bat --install rl_games :: or "isaaclab.bat -i rl_games"
6262
63-
To install only specific Isaac Lab sub-packages, pass a comma-separated list of extras. The available
64-
extras are: ``assets``, ``physx``, ``contrib``, ``mimic``, ``newton``, ``rl``, ``tasks``,
63+
To install only specific sub-packages, pass a comma-separated list of sub-package names. The available
64+
sub-packages are: ``assets``, ``physx``, ``contrib``, ``mimic``, ``newton``, ``rl``, ``tasks``,
6565
``teleop``. For example, to install only the ``mimic`` and ``assets`` sub-packages:
6666

6767
.. tab-set::

docs/source/setup/installation/include/src_clone_isaaclab.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ respectively that provides utilities to manage extensions.
4646
options:
4747
-h, --help show this help message and exit
4848
-i [INSTALL], --install [INSTALL]
49-
Install the Isaac Lab extras and RL frameworks.
50-
Accepts a comma-separated list of extras, one of the RL frameworks, or a special value.
49+
Install Isaac Lab sub-packages and RL frameworks.
50+
Accepts a comma-separated list of sub-package names, one of the RL frameworks, or a special value.
5151
52-
Extras: assets, physx, contrib, mimic, newton, rl, tasks, teleop.
52+
Sub-packages: assets, physx, contrib, mimic, newton, rl, tasks, teleop.
5353
RL frameworks: rl_games, rsl_rl, sb3, skrl, robomimic.
5454
55-
Passing an RL framework name installs all extensions + that framework.
55+
Passing an RL framework name installs all sub-packages + that framework.
5656
5757
Special values:
5858
- all - Install all extensions + all RL frameworks (default).
@@ -84,13 +84,13 @@ respectively that provides utilities to manage extensions.
8484
options:
8585
-h, --help show this help message and exit
8686
-i [INSTALL], --install [INSTALL]
87-
Install the Isaac Lab extras and RL frameworks.
88-
Accepts a comma-separated list of extras, one of the RL frameworks, or a special value.
87+
Install Isaac Lab sub-packages and RL frameworks.
88+
Accepts a comma-separated list of sub-package names, one of the RL frameworks, or a special value.
8989
90-
Extras: assets, physx, contrib, mimic, newton, rl, tasks, teleop.
90+
Sub-packages: assets, physx, contrib, mimic, newton, rl, tasks, teleop.
9191
RL frameworks: rl_games, rsl_rl, sb3, skrl, robomimic.
9292
93-
Passing an RL framework name installs all extensions + that framework.
93+
Passing an RL framework name installs all sub-packages + that framework.
9494
9595
Special values:
9696
- all - Install all extensions + all RL frameworks (default).

source/isaaclab/isaaclab/cli/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,18 @@ def cli() -> None:
3636
nargs="?",
3737
const="all",
3838
help=(
39-
"Install the Isaac Lab extras and RL frameworks.\n"
40-
"Accepts a comma-separated list of extras, one of the RL frameworks, or a special value.\n"
39+
"Install Isaac Lab sub-packages and RL frameworks.\n"
40+
"Accepts a comma-separated list of sub-package names, one of the RL frameworks, or a special value.\n"
4141
"\n"
42-
"Extras: assets, physx, contrib, mimic, newton, rl, tasks, teleop.\n"
42+
"Sub-packages: assets, physx, contrib, mimic, newton, rl, tasks, teleop.\n"
4343
"RL frameworks: rl_games, rsl_rl, sb3, skrl, robomimic.\n"
4444
"\n"
45-
"Passing an RL framework name installs all extensions + that framework.\n"
45+
"Passing an RL framework name installs all sub-packages + that framework.\n"
4646
"\n"
4747
"Special values:\n"
48-
"- all - Install all extensions + all RL frameworks (default).\n"
48+
"- all - Install all sub-packages + all RL frameworks (default).\n"
4949
"- none - Install only the core 'isaaclab' package.\n"
50-
"- <empty> (-i or --install without value) - Install all extensions + all RL frameworks.\n"
50+
"- <empty> (-i or --install without value) - Install all sub-packages + all RL frameworks.\n"
5151
),
5252
)
5353
parser.add_argument(

source/isaaclab/isaaclab/cli/commands/install.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ def _ensure_cuda_torch() -> None:
121121
)
122122

123123

124-
# Valid "extras" names that can be passed to --install.
125-
# Each "extra" maps to a source directory named "isaaclab_<extra>" under source/.
126-
VALID_ISAACLAB_EXTRAS: set[str] = {"assets", "physx", "contrib", "mimic", "newton", "rl", "tasks", "teleop"}
124+
# Valid sub-package names that can be passed to --install.
125+
# Each sub-package maps to a source directory named "isaaclab_<name>" under source/.
126+
VALID_ISAACLAB_SUBPACKAGES: set[str] = {"assets", "physx", "contrib", "mimic", "newton", "rl", "tasks", "teleop"}
127127

128128
# RL framework names accepted.
129129
# Passing one of these installs all extensions + that framework.
@@ -257,15 +257,15 @@ def command_install(install_type: str = "all") -> None:
257257
extensions = None
258258
framework_type = install_type
259259
else:
260-
# Parse comma-separated extras into source directory names.
260+
# Parse comma-separated sub-package names into source directory names.
261261
extensions = ["isaaclab"] # core is always required
262-
for extra in (s.strip() for s in install_type.split(",") if s.strip()):
263-
if extra in VALID_ISAACLAB_EXTRAS:
264-
extensions.append(f"isaaclab_{extra}")
262+
for name in (s.strip() for s in install_type.split(",") if s.strip()):
263+
if name in VALID_ISAACLAB_SUBPACKAGES:
264+
extensions.append(f"isaaclab_{name}")
265265
else:
266-
valid = sorted(VALID_ISAACLAB_EXTRAS) + sorted(VALID_RL_FRAMEWORKS)
267-
print_warning(f"Unknown extra '{extra}'. Valid values: {', '.join(valid)}. Skipping.")
268-
framework_type = "none" # RL framework extras not applied in selective mode
266+
valid = sorted(VALID_ISAACLAB_SUBPACKAGES) + sorted(VALID_RL_FRAMEWORKS)
267+
print_warning(f"Unknown sub-package '{name}'. Valid values: {', '.join(valid)}. Skipping.")
268+
framework_type = "none" # RL frameworks not applied in selective mode
269269

270270
# if on ARM arch, temporarily clear LD_PRELOAD
271271
# LD_PRELOAD is restored below, after installation

0 commit comments

Comments
 (0)