Getting Started:
Checkout and Build From Source
ArchStudio 4

Overview

This document describes how to check out the ArchStudio 4 (and constituent) code from GitHub and build ArchStudio from source.

Casual ArchStudio users or those evaluating the technology should probably just download and install the latest pre-built release. However, ArchStudio developers - those who are interested in developing new ArchStudio components, making changes to ArchStudio itself, or those interested in having bleeding-edge updates to ArchStudio before they go into official release - should check out the ArchStudio source code and build the environment from source.


The Source Code Environment

ArchStudio and related projects are stored and managed in a GitHub repository.

ArchStudio is built in and for the Eclipse development environment. Although you can check out ArchStudio source code without using Eclipse, we recommend doing it in Eclipse so you can actually build the source.

If you are just interested in browsing the source without checking it out, you can browse the raw source archive.


What You'll Need

You will need the following installed on your machine:

A Java 2 Software Development Kit

At the current time, ArchStudio is developed on Java 2 Standard Edition, version 5.0 (J2SE 5.0). You can download the runtime environment or development toolkit from:

http://java.sun.com/javase/downloads/index.jsp

Eclipse 4.2 or Better

You will also need to download Eclipse 4.2 or better, and install it on your machine. Downloads and installation instructions are available at http://www.eclipse.org/. If you already have Eclipse, you can also download and extract a second copy in a separate directory solely for ArchStudio if you so desire.

ArchStudio Itself

You will also need to install ArchStudio itself in order to build ArchStudio. Follow the instructions to install ArchStudio and install it into your Eclipse environment.

Checking Out Source Code

Once you have the tools above installed and running, you can check out the ArchStudio source code. ArchStudio is composed of a number of different plug-ins, each of which contributes a part to the environment.

To check out the code perform the following steps:

  1. Switch to the Git perspective by going to Window | Perspective | Open Perspective | Other... | Select "Git" | Hit OK.
  2. Select "Clone a Git Repository".
  3. In the Source Git Repository dialog box that pops up, enter the following for the URI field: https://github.com/isr-uci-edu/ArchStudio4.git.
  4. Click Next to go to Branch Selection page.
  5. Ensure that "master" is selected.
  6. Click Next again to go to the Local Destination page.
  7. Select "Import all existing projects after clone finishes".
  8. Click Finish.

The checkout may take several minutes. After it is completed, you will want to return to the Plug-in perspective. To do this:

  1. Switch to the Plug-in perspective by going to Window | Perspective | Open Perspective | Other... | Select "Plug-in Development" | Hit OK.

After completing the steps above, you should have the Eclipse environment populated with the many plug-ins used to develop ArchStudio.

Running ArchStudio after a Build from Source

Once the build is done in Eclipse, you can run the built version of ArchStudio by launching it as an Eclipse application. This will start a second copy of Eclipse, which will include the ArchStudio plugins. We have also included an Eclipse launch script in the ArchStudio directory, under res/eclipse.


Common Problem

Some people have reported some errors/problems in the Package Explorer when setting up the archstudio4 project. Often this is because not all the dependent Packages are in the Workspace. Sometimes the problem persists even though all packages are in place.

Occasionally, Package Explorer shows errors to archstudio4, even though all the supporting packages are in the Workspace. One of the most common reasons that the project is marked with errors is due to the a mismatch in what the project needs from Java and what Eclipse is providing to the project. Often this occurs because:

  1. The project's Java compile settings are to an older version not supported in the current project's release.
  2. The project's Java classpaths have not been updated.

Solution 1: Verify/Adjust Java Compile Settings

  1. Select the archstudio4 project in the Package Explorer Pane. Right-click and select 'Properties' to view the Properties Pane.
  2. In the Properties Pane, click on the 'Java Compile' to view the version of Java being used.
  3. Currently Java 1.5 is being supported by ArchStudio4, so be sure the Java Compiler is set to 5.0.

Solution 2: Rebuild the Classpath for the Project

  1. Select the archstudio4 project in the Package Explorer Pane. Right-click and select 'PDE Tools'. Select 'Update Classpath ...'
  2. In the Java Classpath Pane, click on the 'Select All' to update all classpaths for all plugins. Click 'Finish' to apply your update.

Comments? Questions?

Comments or questions on this page should go to Eric M. Dashofy.