GRASP File Structure

The code for GRASP can be installed in a publicly-available directory, for example /usr/local/GRASP. (It can also be installed ``privately" in a single user's home directory, if desired.) The name of this top-level directory must be set in the file SiteSpecific which is contained in the top-level GRASP directory. To do this, edit the file SiteSpecific and set the variable GRASP_HOME to the appropriate value, for example GRASP_HOME=/usr/local/GRASP. Please note that the installation scripts are not designed to ``build" in one location and ``install" in a separate location. You should go through the installation procedure in the same directory where you eventually want the GRASP package to reside.

Within this top level directory resides the entire GRASP package. The directories within this top level are:

Examples_SiteSpecific

Contains examples of SiteSpecific files for different sites, machine-types, and installations. You may find this helpful in the installation process if you want to look at an example, or you are stuck.

bin/

Contains links to all the example programs and scripts in the GRASP package.

data/

Contains (both real and simulated) interferometer data, or symbolic links to this data. See the comments in Section  to find out how to obtain this data.

doc/

Documentation (in TeX, PostScript, DVI, and PDF formats) including this users guide.

include/

Header files used to define structures and other common types in the code. This also include the ANSI C prototypes for all the GRASP functions.

lib/

Contains the GRASP library archive: libgrasp.a. To use any of the GRASP functions within your own code, simply link this library with you own code.

man/

This may be used in the future for UNIX on-line manual pages.

parameters/

Contains parameters such as site location information, and estimated power spectra and whitening functions of future detectors.

src/

Source code for analyzing various aspects of the data stream, distributed among the following directories:

40-meter/ Reading data tapes produced on the Caltech 40 meter prototype prior to 1997.

GRtoolbox/ Source code for the Gravitational Radiation Toolbox, a Matlab (command line and GUI) interface to GRASP.

mexfiles/ Mex-files for use with the Gravitational Radiation Toolbox.

examples/ The source code for all of the examples given in this manual (organized by section). These include:

examples_40meter/ Examples of reading/using old-format 40-meter data.

examples_GRtoolbox/ M-file examples for the Gravitational Radiation Toolbox.

examples_binary-search/ The source code and documentation for a binary-inspiral search carried out on the Caltech 40-meter data from November 1994.

examples_correlation/ Examples of determining correlations between different channels and using the knowledge of these correlations to `clean up' a particular channel.

examples_frame/ Examples of reading/using new-format FRAME data.

examples_galaxy/ Examples of using galactic models to predict source distribution parameters.

examples_inspiral/ Examples of generating inspiral waveforms and searching for them in the data stream using matched filtering.

examples_ringdown/ Examples of generating black-hole-horizon formation ringdown waveforms and searching for them in the data stream using matched filtering.

examples_stochastic/ Examples of simulated production of a stochastic background correlated signal between two detector sites and a pipeline to search the data stream for such signals.

examples_template_bank/ Example code for setting up a bank of binary-inspiral templates and graphing their locations in parameter space.

examples_testmass/ Example code for evaluating binary inspiral waveforms in the testmass limit $m_1 \to 0$ and comparing the resulting waveforms with those calculated by other methods.

examples_timefreq/ Example code illustrating the use of time-frequency techinques for signal detection.

examples_transient/ Example code to generate and search for transient waveforms such as those arising from supernovae.

examples_utility/ Examples of various utility functions, including a translator to produce new-format FRAME data from old format 40-meter data.

correlation/ Code for calculating correlations between different channels and `cleaning' a particular channel.

galaxy/ Modelling the distribution of sources in our galaxy (needed in order to set physical upper-limits using the 40-meter prototype data).

inspiral/ Binary inspiral analysis (including optimal filtering and vetoing).

optimization/ Additional library routines for optimizing GRASP operation of specific platforms (i.e., supercomputers).

ringdown/ Black hole horizon ringdown (including optimal filtering). This can be used to filter for any exponentially-decaying sinusoid.

stochastic/ Stochastic background detection (including optimal filtering and simulated signal production)

transient/ Supernovae and other transient sources.

periodic/ Searches for pulsars and other periodic and quasi-periodic sources.

template_bank/ Code for ``placing'' optimal filters in parameter space.

testmass/ Code for calculating binary inspiral waveforms in the test mass limit $m_1 \to 0$.

timefreq/ Code for time-frequency transforms, and searching for line-like features in the time-frequency maps.

utility/ General purpose utility routines, including the interface to the FRAME library, error handler routines, etc.

testing/

This will eventually contain a suite of programs that test the GRASP installation.