Recent changes to Getting Started

Getting Started modified by kainzp

kainzp — Tue, 04 Nov 2014 14:32:52 -0000

--- v10
+++ v11
@@ -4,22 +4,23 @@
 This guide describes the required steps to set up the development environment for IQM using Eclipse, Subversion, and Maven.

 ##System Requirements##
-1. Oracle JDK 1.6 or higher (<http: www.oracle.com="" technetwork="" java="" javase="" downloads="" index.html="">)
+1. Oracle JDK 1.7 or higher (<http: www.oracle.com="" technetwork="" java="" javase="" downloads="" index.html="">)
 2. Eclipse SDK (<http: www.eclipse.org="" downloads=""/>), or any other Java SDK. However, for this guide we will use Eclipse.
-3. Apache Maven 3.0.x (<http: maven.apache.org=""/>)
+3. Apache Maven 3.x (<http: maven.apache.org=""/>)
 4. Subversion 1.7.x or higher(<http: subversion.apache.org=""/>)
 5. *(Optional) TortoiseSVN or any other SVN desktop integration software with a convenient GUI for handling svn commands (<http: tortoisesvn.tigris.org="">)*

 ##Installation##
 ###Oracle JDK###
-Download and install the Oracle JDK 1.6.0_12 or higher for your operating system (OS) from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 
+Download and install the Oracle JDK 1.7 or higher for your operating system (OS) from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 
 Ensure, that the Oracle JVM is installed correctly and set as your default JVM by typing:
 `$ java -version`

 The output should yield something like:
-`java version "1.6.0_24"`
-`Java(TM) SE Runtime Environment (build 1.6.0_24-b07)`
-`Java HotSpot(TM) Client VM (build 19.1-b02, mixed mode, sharing)`
+`java version "1.7.0_45"`
+`Java(TM) SE Runtime Environment (build 1.7.0_45-b18)`
+`Java HotSpot(TM) 64-Bit Server VM (build 24.45-b08, mixed mode)`
+

 According to the installation instructions and depending on your OS you will have to set environment variables for JAVA_HOME; simply follow the guides and install everything in the default paths.

@@ -40,7 +41,7 @@
 [[img src=eclipse-windows-ws-encoding.png alt="Workspace encoding" width="75%"]]
 This is important, since internationalization may be stored in UTF-8 encoded text files.

-Set the default JVM to JDK 1.6 on your system.
+Set the default JVM to JDK 1.7 on your system.
 [[img src=eclipse-default-JVM.png alt="Default JVM" width="75%"]]

 ###Apache Maven###
@@ -50,12 +51,12 @@
 When your installation is successful, run 
    `mvn --version` 
 from your command line, which should produce something like the following, depending on your OS:
-   `Apache Maven 3.0.5 (r01de14724cdef164cd33c7c8c2fe155faf9602da; 2013-02-19 14:51:28+0100)`
-   `Maven home: /usr/local/apache-maven/apache-maven-3.0.5`
-   `Java version: 1.6.0_24, vendor: Sun Microsystems Inc.`
-   `Java home: /usr/lib/jvm/java-6-sun-1.6.0.24/jre`
-   `Default locale: en_US, platform encoding: UTF-8`
-   `OS name: "linux", version: "3.5.0-17-generic", arch: "i386", family: "unix"`
+`Apache Maven 3.2.1 (ea8b2b07643dbb1b84b6d16e1f08391b666bc1e9; 2014-02-14T18:37:52+01:00)`
+`Maven home: /usr/local/apache-maven/apache-maven-3.2.1`
+`Java version: 1.7.0_45, vendor: Oracle Corporation`
+`Java home: /Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home/jre`
+`Default locale: en_US, platform encoding: UTF-8`
+`OS name: "mac os x", version: "10.9.5", arch: "x86_64", family: "mac"`

 ###Subversion###

Getting Started modified by kainzp

kainzp — Wed, 22 May 2013 07:49:05 -0000

--- v9
+++ v10
@@ -79,7 +79,7 @@
 Subversion will check out all files from the trunk/iqm directory to %IQMROOT%.

 #####Use the TortoiseSVN tool#####
-coming soon.
+See wiki page on [Tortoise Checkout].

 ####Import the custom libraries####
 Use the pre-configured script `import_custom_libs.*` from the %IQMROOT%/application directory in order to import all required libraries not available in central maven repositories.

Getting Started modified by kainzp

kainzp — Thu, 16 May 2013 08:13:41 -0000

--- v8
+++ v9
@@ -66,7 +66,10 @@
 ####Prepare local working copy####
 In order to check out the source from the IQM SVN repository, you have to create a directory at a file system location where the source files will be stored.
 You have to have write permissions on that directory. For this guide, we will use the %IQMROOT% variable referring to this directory.
-For convenience, we will create an *iqm* folder in the user's home directory for this purpose, so that %IQMROOT% points to `/home//iqm-source` (Linux), `/Users//iqm-source` (Mac OS X), or `C:\Users\\iqm-source` (Windows), respectively.
+For convenience, we will create an *iqm-source* folder in the user's home directory for this purpose, so that %IQMROOT% points to 
+- `/home//iqm-source` (Linux), 
+- `/Users//iqm-source` (Mac OS X), or 
+- `C:\Users\\iqm-source` (Windows), respectively.

 ####Check out the head revision of IQM####
 #####Use the command line#####
@@ -116,6 +119,8 @@

 Keep all projects selected and hit FINISH.

+*If you encounter the "Failed to load JavaHL library" warning, do the following as suggested [here](http://stackoverflow.com/questions/11769989/failed-to-load-javahl-library).*
+
 You will get some errors in the first place, but these are quickly resolved by adding the variable `M2_REPO` as classpath variable in Eclipse.
 [[img src=eclipse-import-existing-projects-3.png alt="M2_REPO is missing, step 3"]]

Getting Started modified by kainzp

kainzp — Thu, 16 May 2013 07:28:07 -0000

--- v7
+++ v8
@@ -66,12 +66,12 @@
 ####Prepare local working copy####
 In order to check out the source from the IQM SVN repository, you have to create a directory at a file system location where the source files will be stored.
 You have to have write permissions on that directory. For this guide, we will use the %IQMROOT% variable referring to this directory.
-For convenience, we will create an *iqm* folder in the user's home directory for this purpose, so that %IQMROOT% points to `/home//iqm` (Linux), `/Users//iqm` (Mac OS X), or `C:\Users\\iqm` (Windows), respectively.
+For convenience, we will create an *iqm* folder in the user's home directory for this purpose, so that %IQMROOT% points to `/home//iqm-source` (Linux), `/Users//iqm-source` (Mac OS X), or `C:\Users\\iqm-source` (Windows), respectively.

 ####Check out the head revision of IQM####
 #####Use the command line#####
 Enter the following commands on the command line:
-`$ cd ~/iqm`
+`$ cd ~/iqm-source`
 `$ svn checkout https://svn.code.sf.net/p/iqm/code-0/trunk/iqm .`
 Subversion will check out all files from the trunk/iqm directory to %IQMROOT%.

@@ -80,7 +80,7 @@

 ####Import the custom libraries####
 Use the pre-configured script `import_custom_libs.*` from the %IQMROOT%/application directory in order to import all required libraries not available in central maven repositories.
-On **Windows** systems simply execute the batch file `import_custom_libs.**bat**`, on **Unix** based systems execute the bash script from the shell using `./import_custom_libs.**sh**`.
+On **Windows** systems simply execute the batch file `import_custom_libs.bat`, on **Unix** based systems execute the bash script from the shell using `./import_custom_libs.sh`.
 Maven will download any required libraries and create a repository at the user's home directory using `.m2` as the base for the maven repository.

 ####Build the Eclipse project files####

Getting Started modified by kainzp

kainzp — Wed, 15 May 2013 17:04:16 -0000

--- v6
+++ v7
@@ -6,8 +6,8 @@
 ##System Requirements##
 1. Oracle JDK 1.6 or higher ()
 2. Eclipse SDK (), or any other Java SDK. However, for this guide we will use Eclipse.
-3. Maven 3.0.x ()
-4. Subversion Client 1.7.x or higher()
+3. Apache Maven 3.0.x ()
+4. Subversion 1.7.x or higher()
 5. *(Optional) TortoiseSVN or any other SVN desktop integration software with a convenient GUI for handling svn commands ()*

 ##Installation##
@@ -26,9 +26,9 @@
 ###Eclipse SDK###
 Download the Eclipse SDK (e.g. Juno 4.2.x) from [here](http://www.eclipse.org/downloads/) and unzip it to a custom location.
 Install some useful Eclipse plugins for the development as you like:
-   - Subclipse ()
-   - WindowBuilder ()
-   - MoreUnit ()
+   - Subclipse (, Eclipse update site: )
+   - WindowBuilder (, Eclipse update site: )
+   - MoreUnit (, Eclipse update site: )
 Of course you are free to install any other Eclipse version or IDE using the package manager on your Linux system, but keep in mind the compatibility of your plugins.

 [[img src=eclipse-workspace.png alt="Workspace selection" width="75%"]]
@@ -43,9 +43,93 @@
 Set the default JVM to JDK 1.6 on your system.
 [[img src=eclipse-default-JVM.png alt="Default JVM" width="75%"]]

-###Maven###
+###Apache Maven###
 Download Apache Maven from [here](http://maven.apache.org/) and install it according to the [installation instructions](http://maven.apache.org/download.cgi#Installation) for your OS. You can find a quickstart guide [here](http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
 **We recommend to use the precompiled binaries for your platform.**

+When your installation is successful, run 
+   `mvn --version` 
+from your command line, which should produce something like the following, depending on your OS:
+   `Apache Maven 3.0.5 (r01de14724cdef164cd33c7c8c2fe155faf9602da; 2013-02-19 14:51:28+0100)`
+   `Maven home: /usr/local/apache-maven/apache-maven-3.0.5`
+   `Java version: 1.6.0_24, vendor: Sun Microsystems Inc.`
+   `Java home: /usr/lib/jvm/java-6-sun-1.6.0.24/jre`
+   `Default locale: en_US, platform encoding: UTF-8`
+   `OS name: "linux", version: "3.5.0-17-generic", arch: "i386", family: "unix"`
+
+
 ###Subversion###
 Download and install Apache Subversion according to the [installation instructions](http://subversion.apache.org/packages.html) for your OS. 
+
+##Setup##
+###Source Checkout from SVN###
+####Prepare local working copy####
+In order to check out the source from the IQM SVN repository, you have to create a directory at a file system location where the source files will be stored.
+You have to have write permissions on that directory. For this guide, we will use the %IQMROOT% variable referring to this directory.
+For convenience, we will create an *iqm* folder in the user's home directory for this purpose, so that %IQMROOT% points to `/home//iqm` (Linux), `/Users//iqm` (Mac OS X), or `C:\Users\\iqm` (Windows), respectively.
+
+####Check out the head revision of IQM####
+#####Use the command line#####
+Enter the following commands on the command line:
+`$ cd ~/iqm`
+`$ svn checkout https://svn.code.sf.net/p/iqm/code-0/trunk/iqm .`
+Subversion will check out all files from the trunk/iqm directory to %IQMROOT%.
+
+#####Use the TortoiseSVN tool#####
+coming soon.
+
+####Import the custom libraries####
+Use the pre-configured script `import_custom_libs.*` from the %IQMROOT%/application directory in order to import all required libraries not available in central maven repositories.
+On **Windows** systems simply execute the batch file `import_custom_libs.**bat**`, on **Unix** based systems execute the bash script from the shell using `./import_custom_libs.**sh**`.
+Maven will download any required libraries and create a repository at the user's home directory using `.m2` as the base for the maven repository.
+
+####Build the Eclipse project files####
+The project is pre-configured for an automated creation of eclipse projects for the IQM modules.
+The superior (top-level) pom.xml is located in %IQMROOT%/application/.
+Open a new command prompt at the pom's location and type 
+`mvn clean eclipse:clean eclipse:eclipse` 
+in order to create entirely new projects. 
+The output should be something like the following:
+`[INFO] ------------------------------------------------------------------------`
+`[INFO] Reactor Summary:`
+`[INFO] `
+`[INFO] IQM ............................................... SUCCESS [7.034s]`
+`[INFO] IQM - API ......................................... SUCCESS [6.592s]`
+`[INFO] IQM - Standard Image Operator Bundle .............. SUCCESS [2.725s]`
+`[INFO] IQM - Standard Plot Operator Bundle ............... SUCCESS [0.218s]`
+`[INFO] IQM - Application Core ............................ SUCCESS [0.308s]`
+`[INFO] IQM - Application ................................. SUCCESS [0.788s]`
+`[INFO] ------------------------------------------------------------------------`
+`[INFO] BUILD SUCCESS`
+`[INFO] ------------------------------------------------------------------------`
+`[INFO] Total time: 23.184s`
+`[INFO] Finished at: Wed May 15 18:30:49 CEST 2013`
+`[INFO] Final Memory: 7M/17M`
+`[INFO] ------------------------------------------------------------------------`
+
+####Import the Eclipse projects into Eclipse####
+Run Eclipse and select `File -> Import...`, select `General -> Existing Projects into Workspace` and hit "Next":
+[[img src=eclipse-import-existing-projects-1.png alt="Import existing projects into the Eclipse workspace, step 1" width="75%"]]
+
+Select the root directory by browsing to %IQMROOT%:
+[[img src=eclipse-import-existing-projects-2.png alt="Import existing projects into the Eclipse workspace, step 2" width="75%"]]
+
+Keep all projects selected and hit FINISH.
+
+You will get some errors in the first place, but these are quickly resolved by adding the variable `M2_REPO` as classpath variable in Eclipse.
+[[img src=eclipse-import-existing-projects-3.png alt="M2_REPO is missing, step 3"]]
+
+Select `Window -> Preferences` and search for "Classpath Variables" and hit the `New...` button.
+[[img src=eclipse-import-existing-projects-4.png alt="Import existing projects into the Eclipse workspace, step 4" width="75%"]]
+
+Add the path to your local maven repository, which is located at your user directory at `.m2/repository`.
+[[img src=eclipse-import-existing-projects-5.png alt="Add the path to the local maven repository, step 5"]]
+
+###Perform a first test run###
+Create a new run configuration: 
+- Use a custom name for the configuration
+- Run the `iqm-app` project
+- Use `at.mug.iqm.main.IQM` as the main class
+[[img src=eclipse-run-config.png alt="Eclipse run configuration" width="75%"]]
+
+Hit "Run" and the application will start within your Eclipse IDE.

Getting Started modified by kainzp

kainzp — Wed, 15 May 2013 15:38:16 -0000

Getting started modified by kainzp

kainzp — Wed, 15 May 2013 15:33:02 -0000

--- v4
+++ v5
@@ -1,8 +1,51 @@
-Getting Started
-=======
-This guide describes the required steps to set up the development environment for IQM using Eclipse and Maven.
-
 [TOC]

+##Getting Started##
+This guide describes the required steps to set up the development environment for IQM using Eclipse, Subversion, and Maven.

-Requirements
+##System Requirements##
+1. Oracle JDK 1.6 or higher ()
+2. Eclipse SDK (), or any other Java SDK. However, for this guide we will use Eclipse.
+3. Maven 3.0.x ()
+4. Subversion Client 1.7.x or higher()
+5. *(Optional) TortoiseSVN or any other SVN desktop integration software with a convenient GUI for handling svn commands ()*
+
+##Installation##
+###Oracle JDK###
+Download and install the Oracle JDK 1.6.0_12 or higher for your operating system (OS) from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 
+Ensure, that the Oracle JVM is installed correctly and set as your default JVM by typing:
+`$ java -version`
+
+The output should yield something like:
+`java version "1.6.0_24"`
+`Java(TM) SE Runtime Environment (build 1.6.0_24-b07)`
+`Java HotSpot(TM) Client VM (build 19.1-b02, mixed mode, sharing)`
+
+According to the installation instructions and depending on your OS you will have to set environment variables for JAVA_HOME; simply follow the guides and install everything in the default paths.
+
+###Eclipse SDK###
+Download the Eclipse SDK (e.g. Juno 4.2.x) from [here](http://www.eclipse.org/downloads/) and unzip it to a custom location.
+Install some useful Eclipse plugins for the development as you like:
+   - Subclipse ()
+   - WindowBuilder ()
+   - MoreUnit ()
+Of course you are free to install any other Eclipse version or IDE using the package manager on your Linux system, but keep in mind the compatibility of your plugins.
+
+[[img src=eclipse-workspace.png alt="Workspace selection" width="75%"]]
+Run Eclipse, select a workspace for the development and hit OK. 
+*Note*: Subsitute `` with your user name or choose a different custom location.
+
+On other systems than Linux, you might have to change the default workspace encoding to UTF-8.
+Use `Window -> Preferences` from the Eclipse menu and search for "encoding".
+[[img src=eclipse-windows-ws-encoding.png alt="Workspace encoding" width="75%"]]
+This is important, since internationalization may be stored in UTF-8 encoded text files.
+
+Set the default JVM to JDK 1.6 on your system.
+[[img src=eclipse-default-JVM.png alt="Default JVM" width="75%"]]
+   
+###Maven###
+Download Apache Maven from [here](http://maven.apache.org/) and install it according to the [installation instructions](http://maven.apache.org/download.cgi#Installation) for your OS. You can find a quickstart guide [here](http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
+**We recommend to use the precompiled binaries for your platform.**
+
+###Subversion###
+Download and install Apache Subversion according to the [installation instructions](http://subversion.apache.org/packages.html) for your OS.

Getting started modified by kainzp

kainzp — Wed, 15 May 2013 15:24:27 -0000

Getting started modified by kainzp

kainzp — Wed, 15 May 2013 12:53:40 -0000

--- v2
+++ v3
@@ -1,2 +1,8 @@
+Getting Started
+=======
 This guide describes the required steps to set up the development environment for IQM using Eclipse and Maven.

+[TOC]
+
+
+Requirements

Getting started modified by kainzp

kainzp — Wed, 15 May 2013 12:52:04 -0000