# Source Code Compilation Guide

[![View Source On Gitee](https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source_en.svg)](https://gitee.com/mindspore/docs/blob/master/docs/devtoolkit/docs/source_en/compiling.md)

The following describes how to compile the MindSpore Dev ToolKit project based on the IntelliJ IDEA source code.

## Background

* MindSpore Dev ToolKit is a PyCharm plug-in developed using IntelliJ IDEA. [IntelliJ IDEA](https://www.jetbrains.com/idea/download) and PyCharm are IDEs developed by JetBrains.
* MindSpore Dev ToolKit is developed based on JDK 11. To learn JDK- and Java-related knowledge, visit [https://jdk.java.net/](https://jdk.java.net/).
* [Gradle 6.6.1](https://gradle.org) is used to build MindSpore Dev Toolkit and it does not need to be installed in advance. IntelliJ IDEA automatically uses the "gradle wrapper" mechanism to configure the required Gradle based on the code.

## Required Software

* [IntelliJ IDEA](https://www.jetbrains.com/idea/download)

* JDK 11

  Note: IntelliJ IDEA 2021.3 contains a built-in JDK named **jbr-11 JetBrains Runtime version 11.0.10**, which can be used directly.

    ![img](images/clip_image031.jpg)

## Compilation

1. Verify that the required software has been successfully configured.

2. Download the [project](https://gitee.com/mindspore/ide-plugin) source code from the code repository.

    * Download the ZIP package.

      ![img](images/clip_image032.jpg)

    * Run the git command to download the package.

      ```
      git clone https://gitee.com/mindspore/ide-plugin.git
      ```

3. Use IntelliJ IDEA to open the project.

    3.1 Choose **File** > **Open**.

      ![img](images/clip_image033.jpg)

    3.2 Go to the directory for storing the project.

      ![img](images/clip_image034.jpg)

    3.3 Click **Load** in the dialog box that is displayed in the lower right corner. Alternatively, click **pycharm**, right-click the **settings.gradle** file, and choose **Link Gradle Project** from the shortcut menu.

      ![img](images/clip_image035.jpg)

      ![img](images/clip_image036.jpg)

4. If the system displays a message indicating that no JDK is available, select a JDK. ***Skip this step if the JDK is available.***

    4.1 The following figure shows the situation when the JDK is not available.

      ![img](images/clip_image037.jpg)

    4.2 Choose **File** > **Project Structure**.

      ![img](images/clip_image038.jpg)

    4.3 Select JDK 11.

      ![img](images/clip_image039.jpg)

5. Wait until the synchronization is complete.

    ![img](images/clip_image040.jpg)

6. Build a project.

    ![img](images/clip_image042.jpg)

7. Wait till the build is complete.

    ![img](images/clip_image044.jpg)

8. Obtain the plug-in installation package from the **/pycharm/build/distributions** directory in the project directory.

    ![img](images/clip_image046.jpg)

## References

* This project is built based on section [Building Plugins with Gradle](https://plugins.jetbrains.com/docs/intellij/gradle-build-system.html) in *IntelliJ Platform Plugin SDK*. For details about advanced functions such as debugging, see the official document.