Difference between revisions of "FTEC"

From Genome Analysis Wiki
Jump to: navigation, search
Line 8: Line 8:
 
2) Place downloaded file in the directory where you would like the program to reside and untar the file <br>
 
2) Place downloaded file in the directory where you would like the program to reside and untar the file <br>
 
3) Inside the new directory /FTEC which has been created enter the command 'make' <br>
 
3) Inside the new directory /FTEC which has been created enter the command 'make' <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) 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.
 
  
 
==Windows with MinGW==
 
==Windows with MinGW==
 
1) Instructions for Installing MinGW and MSYS can be found here: [[Using VirtualBox]] <br>
 
1) Instructions for Installing MinGW and MSYS can be found here: [[Using VirtualBox]] <br>
2) Download the appropriate .tar file from below and place it in the folder \msys\1.0\home\user\ where "user" is your user account name
+
2) Download the appropriate .tar 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
+
3) Open the MSYS command line window <br>
4) Untar the file with the command "tar xf File_Name.tar"
+
4) Untar the file with the command "tar xf File_Name.tar" <br>
5) Enter the command "make"
+
5) Enter the newly created folder /FTEC and enter the command "make" <br>
6)  
+
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 ==
+
= 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.  File size and download time increase with the inclusion of each set of library files, so 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.
 
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.  File size and download time increase with the inclusion of each set of library files, so 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.

Revision as of 11:03, 18 January 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 .tar file below
2) Place downloaded file in the directory where you would like the program to reside and untar the file
3) Inside the new directory /FTEC which has been created enter the command 'make'
4) 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: Using VirtualBox
2) Download the appropriate .tar 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) Untar the file with the command "tar xf File_Name.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. File size and download time increase with the inclusion of each set of library files, so 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 (50 Mb)
Program files with TCLAP header files (310 Kb)
Program files without Boost or TCLAP header files (120 Kb)


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

Documentation

User's guide