PIOT-CFG-01-003: Using Eclipse as the IDE

[labbenchstudios]

Description

• This card contains some basic setup and configuration options if you're using Eclipse as the IDE for these exercises.
  • Assumptions:
    • You may have familiarity with Eclipse and its functionality as an IDE.
    • You may have used Eclipse for both Python and Java development.
    • You've successfully installed other applications on your operating system.
  • Some notes:
    • In the Configuration Details for Eclipse section, this guide covers some of the basic configuration options used for my own development environment. Your own needs may require different extensions.

Review the README

• Please see README.md for further information on, and use of, this content.
• License for embedded documentation and source codes: PIOT-DOC-LIC

Estimated effort may vary greatly

• The estimated level of effort for this exercise shown in the 'Estimate' section below is a very rough approximation. The actual level of effort may vary greatly depending on your development and test environment, experience with the requisite technologies, and many other factors.

Configuration Details for Eclipse

***General (for both CDA [Python] and GDA [Java] development)

• Install the latest Eclipse for your platform: https://www.eclipse.org/downloads/
  • This will download the installer - be sure to check the SHA signature
  • Use the installer to install the latest version of Eclipse - follow the instructions in the dialogs
• Launch Eclipse
• Install PyDev
  • In Eclipse, click on Help -> Install New Software...
  • In the Works with text field, type PyDev, press Enter
  • Click on the pydev.org URL
  • Under Name, enable the PyDev checkbox
  • Click Finish
  • You may need to restart Eclipse
• Install updates
  • Click Help -> Check for Updates...
• Install any of your favorite extensions
  • NOTE: Extensions for any IDE can be deeply personal! Those listed below are my own personal choices; that said, Java and Python support is REQUIRED if you're using Eclipse and following along with the instructions in this guide.

CDA Dev Environment Configuration [Python]

• After cloning cda-python-components, navigate to the install directory (referred to as CDA_HOME going forward)
• Notice the .project hidden file - this contains the project settings for your Eclipse project - you shouldn't have to change anything here
• Launch Eclipse and add the cda-python-components path
  • Click File -> Import -> Existing Projects into Workspace
  • Navigate to the CDA_HOME folder
  • Your CDA project should load; however, you'll probably get an error indicating the Source folder: /cda-python-components/src/main/python not found along with one for the tests path - this is easily fixable:
    • Right click on the top level folder cda-python-components
    • Click Properties
    • The dialog will allow you to change the two source paths
    • Highlight the two (pointing to /src/main/python and src/tests/python and click Remove
    • Click Add source folder
      • Select the top level path (CDA_HOME)
      • Click Apply
    • Click Add source folder
      • Select the tests path
      • Click Apply
    • Close the dialog - all errors should now disappear

GDA Dev Environment Configuration [Java]

• After cloning gda-java-components, navigate to the install directory (referred to as GDA_HOME going forward)
• Notice the .project hidden file - this contains the project settings for your Eclipse project - you shouldn't have to change anything here
• Launch Eclipse and add the gda-java-components path
  • Click File -> Import -> Existing Projects into Workspace
  • Navigate to the GDA_HOME folder
  • Your GDA project should load

Estimate

• This process can vary in duration depending on your own computing environment, Internet download speed, etc.

Tests

• N/A