Versions Compared

Old Version 26

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Dexton Anderson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Remove Gradle 7 references

Fully hand-held tutorial on setting up the Java environment to a usable state as quickly as possible. Only knowledge of using the terminal is expected. This tutorial will be completely self-contained (excluding links to downloads).

This guide contains some links to some internal pages; these links are not necessary for setting up the environment and only exist as additional assistance for IHMC personnel and others with access.

Note
iconfalse
titleIHMC Only

For more detailed tutorials, see General Development Environment Setup Guide


The general steps are:

  • Install Java
  • Install Gradle
  • Import Repositories
  • Install and configure IDE


Panel

Table of Contents
maxLevel2

...

Ubuntu

...

Curl

...

Curl is a package manager that we will use to install some software. To install it, open a terminal and run:

Code Block
$ sudo apt install curl

Verify installation by running

Code Block
$ curl --version

Java

...

Open a terminal.

Multiexcerpt include
MultiExcerptNameOpenJDK Ubuntu
PageWithExcerptJava

Gradle

...

We are currently on Gradle 7. We will install it manually for ease of understanding. The official guide is here for reference. (Aside: we do not use the Gradle Wrapper)

...

  • Choose the "complete" version.
  • Remember where you downloaded it.

Unpack Gradle (the following are excerpted from the gradle website)

Open a terminal

...

cd into the directory where you downloaded Gradle. Then

...

Excerpt
  • Unzip the distribution zip file in the directory of your choosing, e.g.:
Code Block
$ sudo mkdir /opt/gradle
$ sudo unzip -d /opt/gradle gradle-7.4.2-all.zip

...

Add to path

Code Block
$ echo 'export PATH=$PATH:/opt/gradle/gradle-7.4.2/bin' >> ~/.bashrc

Verify installation

...

  • Open a console (or a Windows command prompt) and run gradle -v to run gradle and display the version, e.g.:

...

and run the following:

Multiexcerpt include
MultiExcerptNameGradle quickstart
PageWithExcerptGradle

Multiexcerpt include
MultiExcerptNamegradle verify
PageWithExcerptGradle

Configure for IHMC software

Multiexcerpt include
MultiExcerptNamegradle.properties home location
PageWithExcerptGradle

  • Copy paste the following lines into the file
  • Multiexcerpt include
    MultiExcerptNamegradle.properties ubuntu example ihmc employee
    PageWithExcerptGradle
  • Multiexcerpt include
    MultiExcerptNamegradle.properties ubuntu example
    PageWithExcerptGradle


Import Repositories

...

Quick:

Multiexcerpt include
MultiExcerptNameRepo group structureclone command line
PageWithExcerptGeneral Development Java Environment Setup GuideQuickstart

More details:

Multiexcerpt include
MultiExcerptNameclone command lineRepo group structure
PageWithExcerptJava General Development Environment Setup QuickstartGuide


IDE

...

This guide currently only contains instructions for IntelliJ. We are working on Eclipse.

Eclipse

Note
iconfalse
titleIHMC Only

Full guide: Eclipse IDE

Intellij

Note
iconfalse
titleIHMC Only

Full guide: IntelliJ IDEA

  • Download IntelliJ Community. 
    • https://www.jetbrains.com/idea/download/#section=linux
    • Open a terminal and cd into the folder where you downloaded the tar file

    • Extract the file and move it to /opt/. (If you already downloaded from the link above, there is no need to run curl). Replace the names appropriately based on the version you download.

    • Multiexcerpt include
      MultiExcerptNameUbuntu Get IntelliJ
      PageWithExcerptIntelliJ IDEA

    • Multiexcerpt include
      MultiExcerptNameRun Intellij
      PageWithExcerptIntelliJ IDEA

    • Multiexcerpt include
      MultiExcerptNameIntellijDesktopLauncher
      PageWithExcerptIntelliJ IDEA
  • Now you will need to configure IntelliJ to the Java environment you installed.
  • Multiexcerpt include
    MultiExcerptNameIntellijConfiguration Quickstart
    PageWithExcerptIntelliJ IDEA
  • Multiexcerpt include
    MultiExcerptNameIntellij quickstart successful
    PageWithExcerptIntelliJ IDEA


Note
iconfalse
titleIHMC Only

Network Parameters

...

This step is necessary if you are working on high-level behaviors, but not necessary to run the simulations.

Multiexcerpt include
MultiExcerptNamenetworkConfig for IHMC
PageWithExcerptGeneral Development Environment Setup Guide

...

Windows

...

Git

...

Multiexcerpt include
MultiExcerptNameJava SDK Windows
PageWithExcerptJava

Gradle

...

We are currently on use Gradle 7. We will install it manually for ease of understanding. The official guide is here for reference. (Aside: we do not use the Gradle Wrapper)

  • Download the latest Gradle 7 distribution (7.4.2 as of writing).
    • Choose the complete version.
    • Remember where you downloaded it.

  • Unpack Gradle (the following are excerpted from the gradle website)

    Excerpt
    • Create a new directory C:\Gradle with File Explorer.
    • Open a second File Explorer window and go to the directory where the Gradle distribution was downloaded. Double-click the ZIP archive to expose the content. Drag the content folder gradle-7X.4X.2 Xto your newly created C:\Gradle folder.

  • Add to path

    Excerpt
    • In File Explorer right-click on the This PC (or Computer) icon, then click Properties -> Advanced System Settings -> Environmental Variables.
    • Under System Variables select Path, then click Edit. Add an entry for C:\Gradle\gradle-7X.4X.2X\bin. Click OK to save.

    Verify installation

    Excerpt

    Open a console (or a Windows command prompt) and run gradle -v to run gradle and display the version, e.g.:

  • Code Block$ gradle -v ------------------------------------------------------------ Gradle 7.4.2 ------------------------------------------------------------

    Multiexcerpt include
    MultiExcerptNamegradle verify
    PageWithExcerptGradle

  • Configure for IHMC software
  • Multiexcerpt include
    MultiExcerptNamegradle.properties home location
    PageWithExcerptGradle
    • Copy paste the following lines into the file
    • Multiexcerpt include
      MultiExcerptNamegradle.properties windows example ihmc employee
      PageWithExcerptGradle

...

    • Multiexcerpt include
      MultiExcerptName

...

    • gradle.properties windows example
      PageWithExcerpt

...

    • Gradle


Import Repositories

...

Quick:

Multiexcerpt
MultiExcerptNameclone command line

We will be cloning repositories from the command line. 

Open a terminal and cd to a directory where you want to hold your files. The directory is arbitrary, but you will need to remember it.

First, consider a name for your repository group. "repos" works if you only need one workspace. That name will referred to as <repo-name> below.

Run the following:

Your folder structure should now match the above.what is shown in the next section.

More Details:

Multiexcerpt include
MultiExcerptNameRepo group structure
PageWithExcerptGeneral Development Environment Setup Guide

Long Paths

...

Long paths needs to be configured on Windows for our repositories.

Multiexcerpt include
SpaceWithExcerptPUBLIC
MultiExcerptNamewindows git longpaths
PageWithExcerptPUBLIC:Long Paths in Windows

IDE

...

This guide currently only contains instructions for IntelliJ. We are working on Eclipse.

Eclipse

...

Note
iconfalse
titleIHMC Only

Full guide: Eclipse IDE

Intellij

...

Note
iconfalse
titleIHMC Only

Full guide: IntelliJ IDEA

  • Download IntelliJ Community. Choose the .exe for convenience
  • Now you will need to configure IntelliJ to the Java environment you installed.
  • Multiexcerpt include
    MultiExcerptNameIntellijConfiguration Quickstart
    PageWithExcerptIntelliJ IDEA
  • Multiexcerpt include
    MultiExcerptNameIntellij quickstart successful
    PageWithExcerptIntelliJ IDEA


Note
iconfalse
titleIHMC Only

Network Parameters

...

This step is necessary if you are working on high-level behaviors, but not necessary to run the simulations.

Multiexcerpt include
MultiExcerptNamenetworkConfig for IHMC
PageWithExcerptGeneral Development Environment Setup Guide