Semlab Open-Source Programmer's Manual

This document contains instructions for programmers who are interested in developing extensions to the CSLI Semlab's open-source Java software (e.g. NOMOS). Project partners are encouraged to see the appropriate project page for project-specific instructions (such as CVS-based access). For instructions on using standalone, non-development versions of our software, please consult the relevant user manual or software page.

Download

The open-source CSLI software projects are available as modular zip files from http://godel.stanford.edu/public/dist-versions/. The following describes the contents of those files:

• {module}-src.zip (source code)
• {module}-ext.zip (3rd-party software and resources)
• {module}.zip (executables, libraries, everything else)

Modules and Dependencies

The following modules are available and have the specified inter-dependencies:

• corpora  -> (model, util) (NOMOS annotation software module)
• model    -> (util)        (OPI framework module)
• util     -> ()            (general utilities module)

File Structure

Each of the modules have the same top-level file structure:

• /dist contains building and distribution files
• /ext contains third-party software
• /doc contains documentation
• /src contains source code
• /lib contains machine-generated resources and binaries
• /run contains executables and scripts for running agents
• /bin contains the java class files if building from source

Javadocs

Javadocs are available online at http://godel.stanford.edu/public/doc-versions/.

Requirements

Generally, our software is developed in Java and should run on any Java-enabled platform. However, most of our testing is done on Windows XP platforms.

Development with Eclipse

All the modules are actually Eclipse JDK projects. To do development using Eclipse, simply switch your Eclipse workspace to point to the directory where you unzipped the above files (note that if you unzip these files to a directory which has a space character in its path, the startup scripts will fail...we therefore recommend avoiding this by installing in a location which does not contain a space chaaracter in the path). Choose Import... > Existing Projects into Workspace, then select the folder where you unzipped the files. Eclipse will automatically detect these as Java projects. You must change your Java compiler preferences to use Java 5.0, otherwise compile errors will show up.

Development without Eclipse

Sorry. We currently do not support non-Eclipse development.