Contributing to OMERO.insight

Note

See the Contributing Developer documentation for more information about contributing to OME projects in general.

Getting started with OMERO.insight

Getting started with OMERO.insight entails that you have an OMERO.server already deployed.

Installing from source

Since January 2011, the OMERO.insight code base is part of the OMERO code base. See Installing OMERO from source, to check out code using http://git.openmicroscopy.org.

Requirements

• Install a Java 6 or Java 7 Development Kit (JDK), available from Java SE Downloads and required for both the OMERO server and client code. Set the JAVA_HOME environment variable to your JDK installation.

Running code

It is helpful to set up the project in Eclipse. Because the OMERO Java and Python source files are encoded in UTF-8, ensure that the encoding in Eclipse (Preferences ‣ General ‣ Workspace ‣ Text file encoding) is also set to UTF-8.

Build system

Ant

The compilation, testing, launch, and delivery of the application are automated by means of an Ant build file, located under the build directory (See Directory contents). Move to the build directory and, from the command line, enter:

java build

This will display the available targets to compile, run, test, and create a distribution bundle. Use the target you wish, for example:

java build all

Because all the tools needed to build the software are already included in the build directory, you do not need to have Ant on your machine. If you wish to use Ant instead, you can still do it by using the build.xml file under the build directory. However, there are some dependencies to satisfy before; these are clearly documented in the build.xml file itself.

Jenkins

The OME project currently uses Jenkins (formerly known as hudson) as a continuous integration server available here. OMERO.insight is built as part of the “OMERO” jobs. See the contributing developer continuous integration documentation for full details.