Difference between revisions of "FTEC"

From Genome Analysis Wiki
Jump to navigationJump to search
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
fte 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.
+
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==
+
=Installation and Compilation=
 +
 
 +
==Unix==
 +
 
 +
1) Download the appropriate file below <br>
 +
2) Place downloaded file in the directory where you would like the program to reside <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) 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==
 +
1) Instructions for Installing MinGW and MSYS can be found here: [[Installing MinGW & MSYS on Windows]] <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>
 +
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>
 +
6) An executable file named 'FTEC' should now reside in this directory, this is the simulator and can be run using './FTEC -parameters'
  
1) Download the appropriate .tar file linked below
 
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 'fte' which has been created enter the command 'make' <br>
 
4) An executable file named 'fte' should now reside in this directory, this is the simulator and can be run using './fte -parameters'.
 
  
 
For information on how to use the simulator see the user's guide below.
 
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, 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.
  
fte 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 fte including that library's header files the program will compile without problems, so if a user is unsure whether they have a library or not download the larger source file below.
+
[[Media:FTEC_withboost.tar.gz‎‎| Program files with both Boost and TCLAP header files (300 Kb) ]] <br>
 +
[[Media:FTEC_noboost.tar.gz | Program files with TCLAP header files (58 Kb)]] <br>
 +
[[Media:FTEC_src_only.tar.gz | Program files without Boost or TCLAP header files (27 Kb)]] <br>
  
[[Media:Fte_v1.36.tar‎| Program files with both Boost and TCLAP header files (50 Mb) ]] <br>
+
 
[[Media:Fte_v1.36_noboost.tar | Program files with TCLAP header files (270 Kb)]] <br>
+
More information on [http://www.boost.org/ Boost] and the [http://www.boost.org/doc/libs/1_48_0/doc/html/boost_random.html Boost Random Number Library]<br>
[[Media:Fte_v1.36_src_only.tar | Program files without Boost or TCLAP header files (80 Kb)]] <br>
+
More information on the [http://tclap.sourceforge.net/ TCLAP Library]
  
 
== Documentation ==
 
== Documentation ==
 +
 +
[[Media:Fte_Document_06012012.pdf‎ | User's guide]]

Latest revision as of 11: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