Revision as of 16:51, 21 January 2011

This section contains instructions for downloading and installing geWorkbench.

geWorkbench 2.1.0 - System Requirements

Java

• The Java 6 Runtime Environment (JRE6) is required.
• For Windows and Linux, geWorkbench is distributed in two installer forms, one with and one without the JRE6 included. To install a version of geWorkbench that does not include the JRE, the JRE must be installed separately on the machine.
• On MacOSX, the Java 6 JRE is included with MacOSX versions 10.5 and higher with the latest updates.
• The "Generic" distribution of geWorkbench does not include the JRE6. It must be installed separately.
• geWorkbench can run on both 32-bit and 64-bit versions of Java on appropriate OS platforms.

How to choose

• Using an installer version of geWorkbench that inludes the JRE6 allows you to be sure that you are running geWorkbench with the correct version of the JRE. For example, some systems may also have older versions of Java installed.
• You may wish to install a "no JRE" version of geWorkbench if you want to choose between 32 and 64 bit JREs, or to keep up with the latest updates to the JRE.

Obtaining the Java 6 JRE

• The JRE6 can be downloaded from http://java.sun.com/javase/downloads/index.jsp.
• Note: Java 6 is, in places, referred to by Sun as Java 1.6.

Memory

At least 2 GB is recommended. geWorkbench 2.1.0 by default will request up to 1 GB of memory for the Java VM.

Operating System

• Windows XP/Vista/Windows 7 (32 or 64-bit): no special requirements.

• MacOSX: Version 10.5 or higher with latest updates is required to provide the Java 6 JRE (Intel platform only).

• Linux: no special requirements known.

geWorkbench, unless otherwise noted for particular components, can be run on both 32 and 64-bit operating systems and JREs.

IMPORTANT NOTICE ABOUT THE LICENSE

Use of geWorkbench is governed by the rules specified in the software license. Please make sure to read the license and understand your obligations before proceeding to download the application.

Downloads

Up-to-date versions of geWorkbench and the geWorkbench Software Development Kit can be downloaded from the project page at NCI's GForge repository: http://gforge.nci.nih.gov/frs/?group_id=78

Installation Instructions

All three platform-specific versions of geWorkbench (Windows, Linux, and Macintosh) provide an installation wizard (generated using InstallAnywhere).

• Using an installer version of geWorkbench that inludes the JRE6 allows you to be sure that you are running geWorkbench with the correct version of the JRE. For example, some systems may also have older versions of Java installed.
• You may wish to install a "no JRE" version of geWorkbench if you want to choose yourself between 32 and 64 bit JREs, or to keep up with the latest updates to the JRE.
• On Windows and Linux, geWorkbench was tested using installer versions which included the JRE6. The included JREs are 32-bit versions.

A generic version of geWorkbench, which does not use any installer, is also available.

Windows (XP/Vista/Windows 7)

Special note for Vista/Windows 7

If you run the installer on Vista or Windows 7, please install geWorkbench to your root directory, e.g. c:\geWorkbench_2.1.0 rather than to C:\Program Files\geWorkbench_2.1.0.

Installer with JRE6

• File: geWorkbench_v2.1.0_Windows_installer_with_JRE6.exe
• Includes the 32-bit Sun Java 6 JRE.

Download and double-click the installer file to begin installation.

Installer without JRE6

• File: geWorkbench_v2.1.0_Windows_installer_noJRE.exe
• No JRE is included, you must make sure that an appropriate Java 6 JRE is installed on your system before installing geWorkbench.

Download and double-click the installer file to begin installation.

MacOSX

• File: geWorkbench_v2.1.0_MacOSX_installer.zip.
• This version relies on the Java 6 JRE included with recent updates to the MacOSX 10.5+ operating system (Intel platforms only).

Double-click geWorkbench_v2.1.0_MacOSX_installer.zip to begin installation.

Notes

• Requires Mac OS X 10.5 or later with recent updates.
• As Java 6 is not available for the PowerPC platform, regardless of OS X version, geworkbench will not run on the PowerPC platform under any version of OS X.
• The compressed installer should be expanded automatically by the system.

Linux

Installer with JRE6

• File: geWorkbench_v2.1.0_Linux_installer_with_JRE6.bin.
• Includes the 32-bit Sun Java 6 JRE.

Installer without JRE6

• File: geWorkbench_v2.1.0_Linux_installer_noJRE.bin.
• No JRE is included, you must make sure that an appropriate Java 6 JRE is installed on your system before installing geWorkbench.
• You may need to configure the JRE. See section below, "Java Environment Configuration".

Installation

The Linux version of geWorkbench relies on X-Windows being installed and running. If you are running Linux on a server and e.g. you wish to view the application on a Windows desktop, you will also need to run an X-windows server on your desktop machine. See X-Windows configuration instructions below.

After downloading, cd (if needed) to the directory to which you downloaded the installer.

To begin the installation, type the command for the particular version, e.g. for the installer with JRE:

"sh ./geWorkbench_v2.1.0_Linux_installer_with_JRE6.bin".

This will extract geWorkbench into a new directory called geWorkbench_2.1.0.

Running geWorkbench (Linux)

To run geWorkbench, and assuming you are using the Linux bash shell, issue the command:

"./rungeWorkbench_2.1.0"

Generic

A non-installer-based version of geWorkbench is supplied in a Zip file which should work on any platform.

File: geWorkbench_v2.1.0_Generic.zip

Installation

Unzip the file. It will create a directory geWorkbench_2.1.0.

Running geWorkbench (generic)

You must have the Java 6 JRE installed and the JRE must be in the path for geWorkbench (see Java Environment Configuration below).

Windows: you can double click on the file "launch_geWorkbench.bat" to launch geWorkbench, or run it from a command window.

Linux/Unix: Execute the script "launch_geworkbench.sh".

Any: Alternatively, if you have Apache Ant installed, you can type "ant run" in the geWorkbench directory.

Java Environment Configuration

To run a version of geWorkbench that does not include the Java 6 Runtime Environment (JRE6), the JRE6 must be installed and, depending on the platform configured separately.

Two environment variables may need to be properly configured. These are the JAVA_HOME and the PATH variables. They should be configured to point to your own installation of the JRE6.

Here is an example of setting the two environment variables for a JRE installed in the directory /opt:

JAVA_HOME=/opt/jre1.6.0_20

PATH=/opt/jre1.6.0_20/bin:$PATH

Typical steps in running X-windows

Here are some typical steps to configure a remote Linux host and a local desktop X-server. Under Windows, a local X-server can be provided for example by the Cygwin package.

On the remote Linux host (assuming you are using the bash shell), issue the command

• "export DISPLAY=(your IP):0"

where (your IP) should be substituted with the IP address of your local desktop machine.

On your local desktop machine, you may need to

1. start the X-windows server with a command such as "startx". You may need to cd to the X11 bin directory to find this command.
2. allow remote connections with a command such as "xhost +".

Quick Start

A Quick Start guide to geWorkbench is being developed.

Community Support Forums

geWorkbench community forums are operated by the caBIG Molecular Analysis Tools Knowledge Center. There are separate user and developer forums. Anyone can browse through existing postings, but to start a new topic one must first register.

The forums can be viewed at https://cabig-kc.nci.nih.gov/Molecular/forums/

Tutorial data

tutorial_data.zip (3.586 MB) - data files in several different formats useful for the tutorials or just trying out geWorkbench.

Bcell-100.zip (5.256 MB) - A large (100 array) microarray dataset in the geWorkbench matrix format. Data is from the lab of Riccardo Dalla-Favera, Columbia University, and is provided only for use in learning and testing geWorkbench. It was obtained from experiments using Affymetrix HG-U95Av2 chips. This file contains the same data as the previously used file "webmatrix", but with the array subsets given more descriptive names.

Training Slides

A set of PowerPoint training slides for an earlier version of geWorkbench is still available. The PowerPoint file is available from the Project Documentation section of this site.