RapidWright IntelliJ Setup

Step-by-Step Instructions

  1. Make sure you have a Java JDK installed (1.8 minimum, 11 or later recommended). Any distribution such as Adoptium should work. Add the bin folder of your JDK installation to your PATH environment variable.

  2. Download IntelliJ: https://www.jetbrains.com/idea/download/

  3. Install IntelliJ by running the setup executable.

  4. Start IntelliJ, and naviagate through setting selection (if necessary) to the welcome screen.

  5. Choose Open from the Welcome screen and navigate to the RapidWright directory where RapidWright has been installed, then click OK.

_images/intellij_start.png _images/intellij_open.png

  1. The RapidWright project should open and IntelliJ may indicate that it is indexing the project. Click on the 1:Project button at the top left sidebar, this will expand the project tree:

_images/intellij_project.png _images/intellij_run_dev_browser.png

  1. Expand the source tree to navigate to the DeviceBrowser class, RapidWright/src/com.xilinx.rapidwright/device/browser/DeviceBrowser as shown in the screenshot above.

  2. IntelliJ will detect RapidWright’s Gradle build and import it automatically. Gradle downloads all jar dependencies and selects the correct platform-specific GUI library for your OS (Linux or Windows), so no manual library configuration is needed. If IntelliJ does not import the project automatically, right-click on build.gradle in the project tree and choose Link Gradle Project.

  3. You should now be able to run any of the programs in RapidWright in the IntelliJ environment. For example, right-click on DeviceBrowser and choose Run DeviceBrowser.main() from the menu. If successful, the DeviceBrowser will run similar to the screenshot below:

_images/intellij_running_dev_browser.png

  1. The IntelliJ environment should be correctly configured at this point. If you have problems, try setting the RAPIDWRIGHT_PATH environment variable to point to your RapidWright install directory prior to running IntelliJ.