Difference between revisions of "FTEC"

From Genome Analysis Wiki
Jump to: navigation, search
 
Line 6: Line 6:
  
 
1) Download the appropriate file below <br>
 
1) Download the appropriate file below <br>
2) Place downloaded file in the directory where you would like the program to reside, unzip and untar the file <br>
+
2) Place downloaded file in the directory where you would like the program to reside <br>
3) Inside the new directory /FTEC which has been created enter the command 'make' <br>
+
3) Unzip the file with the command 'gunzip Filename.tar.gz' and then unzar the file with the command 'tar -xf Filename.tar' <br>
4) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'
+
4) Inside the new directory /FTEC which has been created enter the command 'make' <br>
 +
5) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'
  
 
==Windows with MinGW==
 
==Windows with MinGW==
Line 14: Line 15:
 
2) Download the appropriate file from below and place it in the folder /msys/1.0/home/user/ where "user" is your user account name <br>
 
2) Download the appropriate file from below and place it in the folder /msys/1.0/home/user/ where "user" is your user account name <br>
 
3) Open the MSYS command line window <br>
 
3) Open the MSYS command line window <br>
4) Unzip the file using the command "gunzip File_Name.tar.gz" and then untar the file with the command "tar xf File_Name.tar" <br>
+
4) Unzip the file using the command "gunzip File_Name.tar.gz" and then untar the file with the command "tar xf Filename.tar" <br>
 
5) Enter the newly created folder /FTEC and enter the command "make" <br>
 
5) Enter the newly created folder /FTEC and enter the command "make" <br>
 
6) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'
 
6) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'

Latest revision as of 10:21, 17 February 2012

FTEC is a coalescent simulation program developed by Mark Reppell, Michael Boehnke, and Sebastian Zöllner capable of modeling samples drawn from a population which has undergone faster than exponential growth.

Installation and Compilation

Unix

1) Download the appropriate file below
2) Place downloaded file in the directory where you would like the program to reside
3) Unzip the file with the command 'gunzip Filename.tar.gz' and then unzar the file with the command 'tar -xf Filename.tar'
4) Inside the new directory /FTEC which has been created enter the command 'make'
5) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'

Windows with MinGW

1) Instructions for Installing MinGW and MSYS can be found here: Installing MinGW & MSYS on Windows
2) Download the appropriate file from below and place it in the folder /msys/1.0/home/user/ where "user" is your user account name
3) Open the MSYS command line window
4) Unzip the file using the command "gunzip File_Name.tar.gz" and then untar the file with the command "tar xf Filename.tar"
5) Enter the newly created folder /FTEC and enter the command "make"
6) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'


For information on how to use the simulator see the user's guide below.

Download

FTEC requires header files from both the Boost and TCLAP libraries to compile and run. There are 3 available downloads below, differing in which of these library files they contain, so that a user can select the most appropriate download for their system. If a user's system already includes a library and they download a version of ftec that includes the library's header files the program will compile without problem, so if there is any uncertainty download the larger source file below.

Program files with both Boost and TCLAP header files (300 Kb)
Program files with TCLAP header files (58 Kb)
Program files without Boost or TCLAP header files (27 Kb)


More information on Boost and the Boost Random Number Library
More information on the TCLAP Library

Documentation

User's guide