Correlator Application Source Code for Multiplatform

From CwWiki

Jump to: navigation, search

Please un-compress this zip file, and compile by using INSTALL.

To retrieve these files, Right-click a link and choose "Save Link As..."

Multiplatform Version

This version needs python installed on your Machine.


SVN

  • svn://cube.evl.uic.edu/corewall/correlator


Contents

[edit]

Required Packages

Correlator used several packages. To test code directly, you will need to install them on your machine, and then use the code we provide you.

These packages are:

  • Subversion, for retrieving the program, helps files, and sample data input.
  • Python is used to make the program. Be sure to choose a version that is compatible with the compiler you plan on using. Also, you need at least version 2.5.
  • WxPython is used for menus and graphics.
  • A C++ compiler. We have currently tested on gcc on the Mac with XCode, version 2.4. We have confirmed that Versions 2.2 and earlier of XCode do not work. You will need to make sure your version of Python is compatible with your version of XCode. The latest version is 2.5. We suggest upgrading to that level.

The links provided are general links, you will have to look for your particular machine on each of those pages.


[edit]

Download the Program Code

Once you have installed Subversion, you will need to download the program. You may do that using the subversion link svn://cube.evl.uic.edu/corewall/correlator. You do not access that link directly. Rather, go to the parent directory of where you want the correlator directory located. (Subversion will make the correlator directory for you.) Then type the following command:

svn co svn://cube.evl.uic.edu/corewall/correlator

The co stands for "Checkout".


[edit]

Set Environment Variables

You will eventually need an environment variable CORE_DIRECTORY set. This is the best time to do it. How you set your environment variables depends on your shell.

A Mac is Unix, so:

The env, set, and printenv commands display all environment variables and their values. env and set are also used to set environment variables and are often incorporated directly into the shell. printenv can also be used to print a single variable by giving that variable name as the sole argument to the command.

In UNIX, the following commands can also be used, but are often dependent on a certain shell. 

export VARIABLE=value  # for Bourne, bash, and related shells
setenv VARIABLE value  # for csh and related shells

For more information, see this link.

Example:

setenv CORE_DIRECTORY /Users/jane/code/correlator

where jane is the user that used svn checkout in her code directory.

You should make CORE_DIRECTORY permanent by putting its definition in your startup file. For csh, that file is .cshrc. For bash it is .exrc, etc.


[edit]

Install supporting Software

The supporting software you need to install now, is listed here, i.e. Python, WxPython, Numerical Python, and XCode. Please install them before proceeding.


[edit]

Make the Program

At this point, we assume that you have an operational shell, supporting software, and a compiler. We are ready to make!

  • Mac/Linux

From Correlator root directory, 

  ./INSTALL
  • Visual Studio

Open Project File in win32 directory, and compile it.


[edit]

Running Correlator

At app directory, 

python correlator.py

Once the program is running, see Tutorial for how to use the program. While using the program, you may refer to User Help for more information.


Return to the Correlator main page.

Retrieved from "http://sqlcore.geo.umn.edu/CoreWallDatabase/cwWiki/index.php/Correlator_Application_Source_Code_for_Multiplatform"