msDebug 安装指南¶
1. 安装说明¶
本工具已集成于CANN中，若已安装CANN且无需更新此工具，可直接使用，无需按本文档安装。
若您的环境尚未安装CANN，请参见《CANN 快速安装》安装昇腾NPU驱动和CANN软件（包含Toolkit和ops包），并配置环境变量。
如需单独升级本工具或使用最新版本，您可通过以下三种方式进行安装：在线安装、离线安装、源码安装。
2. 安装方式¶
2.1 在线安装¶
若您的设备具备互联网访问能力，可通过一条命令自动完成工具的下载与安装。请参见昇腾社区MindStudio下载页面，选择对应的CANN版本，并在安装方式中选择“在线安装”，系统将引导您完成后续操作。
2.2 离线安装¶
对处于企业内网等无外网环境的设备，请先在可联网的机器上下载完整的离线安装包，再将其传输至目标设备进行安装。请参见昇腾社区MindStudio下载页面，选择对应的CANN版本，并在安装方式中选择“离线安装”，获取对应的安装包及操作指引。
2.3 源码安装¶
如需使用最新代码的功能，或对源码进行修改以增强功能，可下载本仓库代码，自行编译、打包工具并完成安装。
2.3.1 环境准备¶
源码编译统一使用 MindStudio 标准构建环境。
- 日常开发或使用已发布镜像，请参考《MindStudio工具开发环境安装指导》。
- 需要从基础操作系统复现环境、执行源码构建验证或单元测试验证时，必须参考《MindStudio统一构建镜像制作指南》，从openEuler基础镜像现场构建环境镜像。
本文档后续的源码编译和单元测试命令，均在上述指定镜像容器或现场构建的环境镜像的容器中执行，CANN 软件包版本、GCC 版本和 Python 版本以统一镜像制作指南为准，本仓库不重复维护。
镜像构建完成后，必须使用统一镜像制作指南第 7 章给出的 ctr_in.py 命令，在交互式终端中启动并进入容器。不得使用普通 docker run 创建容器，也不得使用 docker exec <容器名> bash -c '<命令>' 替代交互式环境；否则可能跳过 Python、GCC 和 CANN 环境初始化。
进入 ctr_in.py 打开的交互式容器 Shell 后，执行如下命令克隆本仓库：
2.3.2 执行编译¶
保持在 ctr_in.py 打开的同一个交互式容器 Shell 中，在仓库根目录执行以下命令，自动完成依赖下载与构建：
构建成功后，安装包将生成在 artifacts/ 目录下。
2.3.3 执行单元测试（可选）¶
此步骤非安装必需。如需验证代码基本功能，可执行单元测试：
命令返回码为 0，且测试用例均无失败，表示单元测试通过。
2.3.4 安装¶
2.3.4.1 准备 run 包¶
安装软件包前需给run包添加可执行权限。进入run包保存路径，执行如下命令，增加可执行权限。
2.3.4.2 安装¶
将run包拷贝到运行环境中，执行以下命令安装。
当回显包含以下信息时，表示软件包安装成功。
[!NOTE]
如果环境中配置过
ASCEND_HOME_PATH环境变量，则会安装到${ASCEND_HOME_PATH}目录下；否则会默认安装到${HOME}/Ascend目录下。如果要指定路径安装，则需添加
--install-path，例如./mindstudio-debugger_<version>_<arch>.run --install-path=./test --run，则将此run包安装到当前目录下的test目录下。若系统中已安装该工具的旧版本，安装过程中会提示是否替换；输入 "y" 可执行覆盖安装。
3. 验证安装¶
安装完成后，执行以下命令验证工具是否安装成功：
若输出不报错，且能显示帮助信息，则表明安装成功。
4. 卸载¶
可通过如下步骤卸载：
- 下载脚本。
[!NOTE]
- 需要联网环境才能下载，若环境不允许联网或处于离线状态，请先在可联网的环境下载该脚本后拷贝到目标设备。
- 若执行命令无响应或出现连接失败、SSL证书错误等问题，请参见FAQ。
- 执行卸载。
其中{tools_name}配置为需卸载的工具名称，可通过python3 ms_install.py help命令查询，在打印信息中的Available Tools字段下显示工具名称。
卸载成功打印如下信息：
5. 升级¶
升级即“先卸后装”。直接执行安装命令，工具将自动卸载旧版本，并引导您完成覆盖安装。
可通过msdebug --version命令查看当前环境的版本信息，再选择需要升级的版本。升级版本时需要关注版本配套关系，请参见《版本说明》。