GYRO/NEO Quick Start

Minimal Description

Extract the GYRO and NEO archives (you have probably already done this) into the desired directory:

$ tar -zxf gyro-7.2.tgz
$ tar -zxf neo-0.1.tgz

In the same directory, make symbolic links:

$ ln -s gyro-6.0.2 gyro
$ ln -s neo-0.1 neo

If you are using csh/tcsh, add the following to .cshrc/.tcshrc:

setenv GYRO_PLAT FRANKLIN
setenv GYRO_DIR $HOME/gyro
setenv NEO_DIR $HOME/neo
setenv PATH ${PATH}:$GYRO_DIR/bin:$NEO_DIR/bin
setenv PYTHONPATH $GYRO_DIR/python:$NEO_DIR/python
setenv IDL_PATH $IDL_DIR/lib:$GYRO_DIR/vugyro

If you are using bash, add the following to .bashrc:

export GYRO_PLAT=JACQUARD
export GYRO_DIR=$HOME/gyro
export NEO_DIR=$HOME/neo
export PATH=${PATH}:$GYRO_DIR/bin:$NEO_DIR/bin
export PYTHONPATH=$GYRO_DIR/python:$NEO_DIR/python
export IDL_PATH=$IDL_DIR/lib:$GYRO_DIR/vugyro

Here, $IDL_PATH is the path to your IDL distribution (for example, your idl command should be in $IDL_DIR/bin). This example assumes you want to install on the NERSC Franklin machine, and that you have extracted the GYRO archive into $HOME. See the list of platforms for a complete list of existing platform templates.

Now log out and back in (or source the rc file and rehash). As a check, from $HOME type:

$ gyro_version_message

You should see a version message. Do not proceed until this works properly. To build the executable, change directory to $GYRO_DIR and type

$ make

You can auto-generate a test directory (in this case a very simple linear case) by typing

$ gyro -g L1-std

If this gives an error, ensure that there is a directory of the form $GYRO_DIR/sim. Now, if you can run interactively, cross your fingers and try this

$ gyro -e L1-std -n 2

Otherwise, if you can only access the batch system, try this

$ gyro_bat -e L1-std -n 2 

If you were able to run this case, you can verify the result by typing

$ gyro_reg L1-std 

A closer look at platform-specific configuration

Let's look at this again, but in more detail. First, you need to define two new environment variables:

setenv GYRO_PLAT <platform>
setenv GYRO_DIR <localdir>

<platform> specifies the system you are running on. The existing choices for <platform> are given here.

<localdir> defines the location of the GYRO installation (i.e., the directory into which GYRO was extracted).

The rest of the additions to the shell rc files are essentially fixed. Finally, you must ensure that python is installed on your system, because the file parsers assume that /usr/bin/python exists.