MindStudio Debugger Installation Guide

1. Binary Installation

The MindStudio toolchain is integrated into the CANN package for release. msDebug is stored in the {install_cann_path}/cann/tools/msdebug directory. You can install the CANN package in either of the following ways:

Method 1: Install the software according to the CANN official document

For details, see CANN Installation Guide. Perform the installation and configuration step by step according to the document.

Method 2: Use the official CANN container image

Visit CANN official image repository. Pull the image and start the container according to the instructions in the repository.

2. Source Code Installation

To use the functions of the latest code or modify the source code to enhance functions, you can download the code from this repository, build and package the tool, and install it.

2.1 Environment Setup

Set up the environment by referring to the Operator Tool Development Environment Setup Guide.

The requirements for compilation tools are as follows:

The GCC version must be later than 7.4.0.
The CMake version must be later than 3.20.2 and earlier than 3.31.10.
Git LFS is installed.

2.2 Building and Packaging

Run the one-click script to automatically download and build the dependency repository:

python build.py

NOTE

If you have modified the code in the local dependency sub-repositories and wish to skip the update process during the build, run python build.py local.

When the following information is displayed, the package is built and the .run package is generated.

"mindstudio-debugger_<version>_<arch>.run" successfully created.

By default, the built .run package is saved in the output directory. In the file name, <version> indicates the version number and <arch> indicates the CPU architecture.

NOTE

The generation of the .runfile depends on the pigz library, which is typically provided by the system. If no version is displayed in pigz --version, download it.

2.3 Installation and Uninstallation

2.3.1 Preparing the .run Package

Before installation, grant the execute permission to the .run package. Go to the directory where the .run package is saved and run the following command to add the execute permission:

chmod +x mindstudio-debugger_<version>_<arch>.run

2.3.2 Installation

Copy the .run package to the operating environment and run the following command to install it:

./mindstudio-debugger_<version>_<arch>.run --run

When the following information is displayed, the software package is successfully installed:

mindstudio-debugger package install success!

NOTE

If the ASCEND_HOME_PATH environment variable is configured, the software package will be installed to ${ASCEND_HOME_PATH}. Otherwise, it will be installed to ${HOME}/Ascend.
To specify a custom installation path, use the --install-path option. For example: ./mindstudio-debugger_<version>_<arch>.run --install-path=./test --run installs the .run package to the test directory in the current directory.
If an earlier version of the tool has been installed in the system, a message will be displayed during the installation asking you whether to replace it. Enter "y" to perform an overwrite installation.

2.3.3 Uninstallation

Run the following command to uninstall the software:

./mindstudio-debugger_<version>_<arch>.run --uninstall

When the following information is displayed, the software package is successfully uninstalled:

mindstudio-debugger uninstall success!

NOTE

By default, the uninstallation targets the directory in ${HOME}/Ascend. If the package is installed using the --install-path option, specify the same path during uninstallation, for example, ./mindstudio-debugger_<version>_<arch>.run --install-path=./test --uninstall.

If the .run package has been deleted, run the following command to uninstall the software:

bash $HOME/Ascend/share/info/mindstudio-debugger/script/uninstall.sh   # For custom installation paths, run "bash ./xxx/share/info/mindstudio-debugger/script/uninstall.sh".

2.3.4 Upgrade

To replace the installed mindstudio-debugger package with the .run package, run the following command:

./mindstudio-debugger_<version>_<arch>.run --run

During the process, you will be prompted do you want to overwrite current installation? [y/n] Enter y to proceed with the automatic upgrade.

NOTE

By default, the upgrade targets the mindstudio-debugger directory in ${HOME}/Ascend. If the previous version is installed to a custom path, use the --install-path option, for example, ./mindstudio-debugger_<version>_<arch>.run --install-path=./test --run, where test is the previous installation directory.