Installing Vision SDK

Installation Precautions

The user for installing and running Vision SDK must meet the following requirements:
- You are advised to install and run Vision SDK as a common user. If the root user is used to run programs, permissions may be tampered with.
- The user who installs and runs Vision SDK must be the same.
- Vision SDK and Toolkit must be installed by the same user.
Logs related to the installation, upgrade, uninstallation, and version query of the software package are saved to the ~/log/mindxsdk/deployment.log file. Logs related to integrity check, file extraction, and tar command access are saved to the ~/log/makeself/makeself.log file. You can view the corresponding files for log tracing and audit.
During Vision SDK installation, operators are copied to the CANN installation path. Therefore, after Vision SDK is installed, if CANN is uninstalled and re-installed, operators cannot be found. In this case, reinstall Vision SDK.
To upgrade or uninstall Vision SDK, see Upgrade or Uninstallation.

Preparations for Installation

Deploy the environment by referring to Installing Dependencies.
Obtain the Vision SDK package of the required version from Obtaining the Vision SDK Package.
Ensure that the configuration scripts of CANN environment variables have been executed in the installation environment for the environment variables to take effect. Use the actual installation path.
```
# Install the toolkit package.
. /usr/local/Ascend/cann/set_env.sh # Default CANN installation path. Change it to the actual path.
```

Installation Procedure

Log in to the installation environment.
Upload the Vision SDK package to any path in the installation environment and go to the path where the package is located.

Grant the execute permission on the software package.

chmod u+x Ascend-mindxsdk-mxvision_{version}_linux-{arch}.run

Check the consistency and integrity of the software package.
```
./Ascend-mindxsdk-mxvision_{version}_linux-{arch}.run --check
```
If the system does not have the shasum or sha256sum tool, the verification will fail. In this case, you need to install either the shasum or sha256sum tool.

If the following information is displayed, the software package meets the consistency and integrity requirements:
1
Verifying archive integrity... 100% SHA256 checksums are OK. All good.
Create an installation path for the Vision SDK package. You are not advised to install Vision SDK in /tmp.
- If you need to specify an installation path, create it first. /home/work/Mind_SDK is an example installation path.
  1
  mkdir -p /home/work/Mind_SDK
- If you do not specify an installation path, the software is installed in the path where the Vision SDK package is located by default.
Go to the directory where the software package is uploaded and run the following command to install Vision SDK. For details about the restrictions on the installation path, see the description of --install-path in Table 1. When you install Vision SDK, a window pops out to ask you whether you accept Huawei Enterprise End User License Agreement (EULA). If you want to skip this step, add echo y | before the installation command, indicating that you accept this agreement.
- If an installation path is specified, run the following command to install the software. /home/work/Mind_SDK is an example installation path.
```
./Ascend-mindxsdk-mxvision_{version}_linux-{arch}.run --install --install-path=/home/work/Mind_SDK
```
  or
```
echo y | ./Ascend-mindxsdk-mxvision_{version}_linux-{arch}.run --install --install-path=/home/work/Mind_SDK
```
- If no installation path is specified, run the following command to install the software in the current path.
```
./Ascend-mindxsdk-mxvision_{version}_linux-{arch}.run --install
```
  or
```
echo y | ./Ascend-mindxsdk-mxvision_{version}_linux-{arch}.run --install
```
The --install command also supports optional options. For details, see Table 1.
Optional: If "Do you accept the EULA to install mxVision?" is displayed during the installation, enter Y or y to accept the EULA and continue the installation. Entering other characters stop the installation and exit the program.
If no error information is displayed after the installation is complete, the software is successfully installed in the specified or default path.
```
Successfully installed mindx-xxx
```
For details about the API parameters, see Table 1.
Make the environment variables take effect.
Go to the installation path of Vision SDK and run the following command for the Vision SDK environment variables to take effect.
1
source set_env.sh
After Vision SDK is installed, you can verify the installation and preliminarily understand Vision SDK application development by referring to Quick Start.

Some APIs are implemented through Ascend C operators. After the installation and deployment, files related to Ascend C operators are generated in the installation path.

References

**Table 1** API options
Option	Description
--help \| -h	Queries help information.
--info	Queries the construction information.
--list	Queries the file list.
--check	Queries the integrity of the package.
--quiet \| -q	Enables the quiet mode. Huawei Enterprise End User License Agreement (EULA) is accepted by default. This parameter must be used together with --install or --upgrade.
--noexec	Skips the execution of the internal script.
--extract=<path>	Extracts files to the target directory (absolute path or relative path). This option is used together with --noexec. It is used only to extract files without running them.
--tar arg1 [arg2 ...]	Accesses the content of the archive file using the tar command.
--install	Starts the installation. The current path cannot contain invalid characters. Only letters, digits, and special characters (-_./) are supported.
--install-path=<path>	(Optional) Customizes the root directory for installing the software package. If this parameter is not set, the directory where the current command is executed is used by default. You are advised to use an absolute path to install the development kit. Do not use a relative path when specifying the installation path. This parameter conflicts with --version. You are not advised to install Vision SDK in /tmp. This parameter must be used together with --install or --upgrade. The input parameter path cannot contain invalid characters. Only letters, digits, and special characters (-_./) are supported.
--uninstall	Performs uninstallation. This parameter is valid only for the installation package in the same directory as the RUN package. For details, see Uninstallation. The current path cannot contain invalid characters. Only letters, digits, and special characters (-_./) are supported.
--cann-path	Specifies the user-defined CANN installation path. If the CANN installation path is user-defined, use this parameter to import the path. For example, /home/xxx/Ascend.
--upgrade	Upgrades Vision SDK. For details, see Upgrade.
--version	Queries the Vision SDK version.
--choose-gcc=<0,1>	Selects the corresponding RUN package based on the GCC version. This parameter must be used together with --install or --upgrade. 0: (default) installs GCC 7. 1: installs GCC 4.8.5.
--nox11	This API is discarded and has no function. If it has been used, it must be used together with --install or --upgrade.

The following options are not displayed in --help. Do not use them directly.

--xwin: uses the xwin operating mode.
--phase2: performs the second step.

Parent topic: Installation and Deployment