Subsections

2 Contents of the FREGENE Package

2.1 Fregene_source directory

This directory contains the FREGENE source code. The main program is fregene.cc and all other files are routines that are called by the main program. In each file, a variable called DEBUG is defined and set to 0 by default. If the user changes it to 1 and recompiles the program then step-by-step details of the program will be printed out on the standard output device (or log file). This option is useful to understand how FREGENE works, but it usually generates very large log files.

2.2 Sample directory

This directory contains the SAMPLE source code. The main program is sample.cc and all other files are routines that are called by this program.

2.3 Common directory

It contains:

2.4 Example directory

This directory illustrates how to use FREGENE. It provides one example of each input file required by FREGENE as well as a shell file to run FREGENE.



Imperial College -- August 2008