使用 Isaac Sim 预编译二进制安装#

以下步骤首先从其预构建的二进制文件中安装 Isaac Sim,然后从源代码中安装 Isaac Lab。

安装Isaac Sim#

下载预构建的二进制文件#

Isaac Sim 二进制文件可以直接从 这里 下载为 zip 文件。如果您想使用旧版本的 Isaac Sim 4.5,请在 这里 查看旧版下载页面。

下载完成 zip 文件后,您可以将其解压到所需目录。有关解压 Isaac Sim 二进制文件的示例设置说明,请参考 Isaac Sim 文档

在Linux系统上,我们假设Isaac Sim目录被命名为 ${HOME}/isaacsim

在Windows系统上,我们假设Isaac Sim目录被命名为 C:/isaacsim

验证 Isaac Sim 安装#

为避免每次都要找到并定位 Isaac Sim 安装目录的开销,我们建议为剩下的安装指南将以下环境变量导出到您的终端:

# Isaac Sim root directory
export ISAACSIM_PATH="${HOME}/isaacsim"
# Isaac Sim python executable
export ISAACSIM_PYTHON_EXE="${ISAACSIM_PATH}/python.sh"
:: Isaac Sim root directory
set ISAACSIM_PATH="C:\isaacsim"
:: Isaac Sim python executable
set ISAACSIM_PYTHON_EXE="%ISAACSIM_PATH:"=%\python.bat"

检查仿真器是否正常运行:

# note: you can pass the argument "--help" to see all arguments possible.
${ISAACSIM_PATH}/isaac-sim.sh
:: note: you can pass the argument "--help" to see all arguments possible.
%ISAACSIM_PATH%\isaac-sim.bat

检查仿真器是否可以从独立的 python 脚本中运行:

# checks that python path is set correctly
${ISAACSIM_PYTHON_EXE} -c "print('Isaac Sim configuration is now complete.')"
# checks that Isaac Sim can be launched from python
${ISAACSIM_PYTHON_EXE} ${ISAACSIM_PATH}/standalone_examples/api/isaacsim.core.api/add_cubes.py
:: checks that python path is set correctly
%ISAACSIM_PYTHON_EXE% -c "print('Isaac Sim configuration is now complete.')"
:: checks that Isaac Sim can be launched from python
%ISAACSIM_PYTHON_EXE% %ISAACSIM_PATH%\standalone_examples\api\isaacsim.core.api\add_cubes.py

小心

如果您之前使用过 Isaac Sim 的旧版本,您需要在安装后 第一次 运行以下命令,以删除所有旧用户数据和缓存变量:

${ISAACSIM_PATH}/isaac-sim.sh --reset-user
%ISAACSIM_PATH%\isaac-sim.bat --reset-user

如果按照上述说明仿真器无法运行或崩溃,意味着某些配置不正确。要调试和故障排除,请查看 Isaac Sim 文档论坛

安装Isaac Lab#

克隆Isaac Lab#

备注

我们建议制作 fork 以便贡献到该项目,但这并不是使用该框架的必要条件。如果您制作了一个fork,请用你的用户名替换以下的 isaac-sim

将Isaac Lab库克隆到你项目的工作空间:

git clone git@github.com:isaac-sim/IsaacLab.git
git clone https://github.com/isaac-sim/IsaacLab.git

我们分别为 Linux 和 Windows 提供了一个帮助可执行文件 isaaclab.shisaaclab.bat ,用于管理扩展。

./isaaclab.sh --help

usage: isaaclab.sh [-h] [-i] [-f] [-p] [-s] [-t] [-o] [-v] [-d] [-n] [-c] -- Utility to manage Isaac Lab.

optional arguments:
   -h, --help           Display the help content.
   -i, --install [LIB]  Install the extensions inside Isaac Lab and learning frameworks (rl_games, rsl_rl, sb3, skrl) as extra dependencies. Default is 'all'.
   -f, --format         Run pre-commit to format the code and check lints.
   -p, --python         Run the python executable provided by Isaac Sim or virtual environment (if active).
   -s, --sim            Run the simulator executable (isaac-sim.sh) provided by Isaac Sim.
   -t, --test           Run all python pytest tests.
   -o, --docker         Run the docker container helper script (docker/container.sh).
   -v, --vscode         Generate the VSCode settings file from template.
   -d, --docs           Build the documentation from source using sphinx.
   -n, --new            Create a new external project or internal task from template.
   -c, --conda [NAME]   Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
   -u, --uv [NAME]      Create the uv environment for Isaac Lab. Default name is 'env_isaaclab'.
isaaclab.bat --help

usage: isaaclab.bat [-h] [-i] [-f] [-p] [-s] [-v] [-d] [-n] [-c] -- Utility to manage Isaac Lab.

optional arguments:
   -h, --help           Display the help content.
   -i, --install [LIB]  Install the extensions inside Isaac Lab and learning frameworks (rl_games, rsl_rl, sb3, skrl) as extra dependencies. Default is 'all'.
   -f, --format         Run pre-commit to format the code and check lints.
   -p, --python         Run the python executable provided by Isaac Sim or virtual environment (if active).
   -s, --sim            Run the simulator executable (isaac-sim.bat) provided by Isaac Sim.
   -t, --test           Run all python pytest tests.
   -v, --vscode         Generate the VSCode settings file from template.
   -d, --docs           Build the documentation from source using sphinx.
   -n, --new            Create a new external project or internal task from template.
   -c, --conda [NAME]   Create the conda environment for Isaac Lab. Default name is 'env_isaaclab'.
   -u, --uv [NAME]      Create the uv environment for Isaac Lab. Default name is 'env_isaaclab'.

配置Python环境(可选)#

注意

此步骤是可选的。如果您使用Isaac Sim捆绑的Python,可以跳过此步骤。

强烈建议 为 Isaac Lab 创建一个专用的 Python 环境,即使是可选的。使用虚拟环境有助于:

  • 避免与系统 Python 或安装在您的计算机上的其他项目发生冲突。

  • 保持依赖项隔离 ,使得其他项目中的软件包升级或实验不会破坏 Isaac Sim。

  • 轻松管理多个环境 ,适用于具有不同版本依赖的设置。

  • 简化再现性 — 环境仅包含当前项目所需的软件包,使得更容易与同事共享设置或在不同机器上运行。

您可以选择不同的软件包管理器来创建虚拟环境。

  • UV: 一个现代、快速和安全的 Python 软件包管理器。

  • Conda: 一个适用于各种平台的、与编程语言无关的 Python 软件包管理器。

创建后,您可以在虚拟环境中使用默认的 Python( pythonpython3 ),而不是 ./isaaclab.sh -pisaaclab.bat -p

小心

虚拟环境的 Python 版本必须与 Isaac Sim 的 Python 版本匹配。

  • 对于 Isaac Sim 5.X,请使用 Python 3.11。

  • 对于 Isaac Sim 4.X,请使用 Python 3.10。

使用不同的 Python 版本将导致运行 Isaac Lab 时出现错误。

要安装 uv ,请按照 这里 的说明。您可以使用以下命令创建 Isaac Lab 环境:

# Option 1: Default environment name 'env_isaaclab'
./isaaclab.sh --uv  # or "./isaaclab.sh -u"
# Option 2: Custom name
./isaaclab.sh --uv my_env  # or "./isaaclab.sh -u my_env"
# Activate environment
source ./env_isaaclab/bin/activate  # or "source ./my_env/bin/activate"

警告

UV 目前不支持 Windows 系统。请查看 issue #3483 以跟踪进展。

要安装 conda,请按照 这里 <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html>__ 的说明。您可以使用以下命令创建 Isaac Lab 环境。

我们建议使用 Miniconda ,因为它是轻巧且资源高效的环境管理系统。

# Option 1: Default environment name 'env_isaaclab'
./isaaclab.sh --conda  # or "./isaaclab.sh -c"
# Option 2: Custom name
./isaaclab.sh --conda my_env  # or "./isaaclab.sh -c my_env"
# Activate environment
conda activate env_isaaclab  # or "conda activate my_env"
:: Option 1: Default environment name 'env_isaaclab'
isaaclab.bat --conda  :: or "isaaclab.bat -c"
:: Option 2: Custom name
isaaclab.bat --conda my_env  :: or "isaaclab.bat -c my_env"
:: Activate environment
conda activate env_isaaclab  # or "conda activate my_env"

一旦您进入虚拟环境,您就不需要使用 ./isaaclab.sh -p / isaaclab.bat -p 来运行Python脚本。您可以使用环境中的默认Python可执行文件,即通过运行 pythonpython3 。不过,在接下来的文档中,我们将假设您使用 ./isaaclab.sh -p / isaaclab.bat -p 来运行Python脚本。这条命令相当于在您的虚拟环境中运行 pythonpython3

安装#

  • 使用 apt 来安装依赖(仅适用于Linux):

    # these dependency are needed by robomimic which is not available on Windows
    sudo apt install cmake build-essential
    
  • 运行安装命令,遍历 source 目录中的所有扩展,同时使用带有 --editable 标志的pip进行安装:

    ./isaaclab.sh --install # or "./isaaclab.sh -i"
    
    isaaclab.bat --install :: or "isaaclab.bat -i"
    

    默认情况下,上述命令将安装 所有 学习框架。这些包括 rl_gamesrsl_rlsb3skrlrobomimic

    上述代码将按默认设置安装所有学习框架。如果您想只安装特定框架,可以将框架的名称作为参数传递。例如,为了只安装 rl_games 框架,您可以运行

    ./isaaclab.sh --install rl_games  # or "./isaaclab.sh -i rl_games"
    
    isaaclab.bat --install rl_games :: or "isaaclab.bat -i rl_games"
    

    有效选项是 all, rl_games, rsl_rl, sb3, skrl, robomimicnone 。如果传递 none ,则不会安装任何学习框架。

验证 Isaac Lab 安装#

要验证安装是否成功,请从存储库顶部运行以下命令:

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

# Option 2: Using python in your virtual environment
python scripts/tutorials/00_sim/create_empty.py
:: Option 1: Using the isaaclab.bat executable
:: note: this works for both the bundled python and the virtual environment
isaaclab.bat -p scripts\tutorials\00_sim\create_empty.py

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

上述命令应该启动仿真器,并显示具有黑色视口的窗口。您可以通过在终端上按 Ctrl+C 来退出脚本。在 Windows 机器上,请使用命令提示符从 Ctrl+BreakCtrl+fn+B 终止进程。

带有黑色窗口的仿真器

如果您看到这个,那么安装成功了! 🎉

备注

如果出现错误 ModuleNotFoundError: No module named 'isaacsim' ,请确保虚拟环境已激活且已执行 source _isaac_sim/setup_conda_env.sh (uv也一样)。

训练一个机器人!#

现在您可以通过强化学习使用 Isaac Lab 来训练机器人!使用预定义的工作流和我们 功能齐全 的机器人任务是使用 Isaac Lab 的最快方式。执行以下命令快速训练一只蚂蚁走路!我们建议添加 --headless 以加快训练速度。

./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
isaaclab.bat -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Ant-v0 --headless

… 或者一只机器狗!

./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
isaaclab.bat -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless

Isaac Lab 提供了您需要的工具,以创建您自己所需的 TasksWorkflows ,以满足您的项目需求。请查看我们的 操作指南 指南,如 添加自己的学习库包装环境 以获取详细信息。

Idle hands...