Skip to content

Commit 0304834

Browse files
committed
update documents
1 parent 80cf5f3 commit 0304834

27 files changed

Lines changed: 370 additions & 37 deletions

_data/pubdata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ references:
142142
URL: https://academic.oup.com/gbe/article/11/12/3341/5571717
143143
DOI: 10.1093/gbe/evz193
144144
ISSN: '1759-6653'
145-
message: When using the tests of symmetry (--symtest) please cite:
145+
message: When using the <a href="doc/Assessing-Phylogenetic-Assumptions">tests of symmetry</a> please cite&#58;
146146
new: yes
147147

148148
- author:

doc/Advanced-Tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: userdoc
33
title: "Advanced Tutorial"
4-
author: Jana, M Bui, Minh Bui
4+
author: Jana, Minh Bui
55
date: 2019-12-01
66
docid: 4
77
icon: info-circle

doc/Analyzing-Big-Data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: userdoc
33
title: "Analyzing Big Data"
4-
author: M Bui, Minh Bui
4+
author: Minh Bui
55
date: 2018-11-19
66
docid: 31
77
icon: info-circle

doc/Assessing-Phylogenetic-Assumptions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Tests of symmetry
3636
-----------------
3737

3838
IQ-TREE provides three matched-pairs tests of symmetry ([Naser-Khdour et al., 2019]) to
39-
test the two assumptions of stationarity and homogeneity (SRH).
39+
test the two assumptions of _stationarity_ and _homogeneity_.
4040
A simple analysis:
4141

4242
iqtree2 -s example.phy -p example.nex --symtest-only
@@ -138,7 +138,8 @@ It shows phylogenetic information of the alignment `example.phy`.
138138
(unresolved quartets). A good data set should have high number of fully resolved quartets
139139
and low number of unresolved quartets.
140140

141-
The meanings can also be found in the `LIKELIHOOD MAPPING STATISTICS` section of the report file `example.phy.iqtree`:
141+
The meanings can also be found in the `LIKELIHOOD MAPPING STATISTICS` section of the
142+
report file `example.phy.iqtree`:
142143

143144

144145
LIKELIHOOD MAPPING STATISTICS

doc/Command-Reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: userdoc
33
title: "Command Reference"
4-
author: Diep Thi Hoang, Dominik Schrempf, Heiko Schmidt, Jana Trifinopoulos, M Bui, Minh Bui
5-
date: 2021-03-11
4+
author: Diep Thi Hoang, Dominik Schrempf, Heiko Schmidt, Jana Trifinopoulos, Minh Bui
5+
date: 2021-03-15
66
docid: 19
77
icon: book
88
doctype: manual

doc/Compilation-Guide.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: userdoc
33
title: "Compilation Guide"
44
author: Dominik Schrempf, Jana Trifinopoulos, Meaningseeking, Minh Bui
5-
date: 2020-07-22
5+
date: 2021-04-19
66
docid: 20
77
icon: book
88
doctype: manual
@@ -44,9 +44,11 @@ General requirements
4444

4545
* [CMake](http://www.cmake.org) version >= 2.8.10.
4646

47-
* [Eigen3 library](https://eigen.tuxfamily.org) (for IQ-TREE version >= 1.6). By default IQ-TREE will detect the path to the installed Eigen3 library. If this failed, you have to manually specify `-DEIGEN3_INCLUDE_DIR=<installed_eigen3_dir>` to the `cmake` command (see below).
47+
* [Boost library](https://www.boost.org) for IQ-TREE version 2. Boost library is typically available under Linux. Under MacOS you use [Homebrew](https://brew.sh) and run `brew install boost` to install the Boost library. By default IQ-TREE will detect the path to the installed Boost library.
4848

49-
* (_Optional_) If you want to compile the multicore version, make sure that the OpenMP library was installed. This should typically be the case with `gcc` under Linux.
49+
* [Eigen3 library](https://eigen.tuxfamily.org) (for IQ-TREE version >= 1.6). Under MacOS you use [Homebrew](https://brew.sh) and run `brew install eigen` to install the Boost library. By default IQ-TREE will detect the path to the installed Eigen3 library. If this failed, you have to manually specify `-DEIGEN3_INCLUDE_DIR=<installed_eigen3_dir>` to the `cmake` command (see below).
50+
51+
* OpenMP library, which is used to compile the multicore version. This should typically be the case with `gcc` under Linux. Under MacOS you use [Homebrew](https://brew.sh) and run `brew install libomp` to install the OpenMP library.
5052

5153
* (_Optional_) Install [git](https://git-scm.com) if you want to clone source code from [IQ-TREE GitHub repository](https://github.com/Cibiv/IQ-TREE).
5254

@@ -56,10 +58,18 @@ Downloading source code
5658

5759
Choose the source code (`zip` or `tar.gz`) of the IQ-TREE release you want to use from:
5860

61+
<https://github.com/iqtree/iqtree2/releases>
62+
63+
For IQ-TREE version 1 please use:
64+
5965
<https://github.com/Cibiv/IQ-TREE/releases/>
6066

6167
Alternatively, if you have `git` installed, you can also clone the source code from GitHub with:
6268

69+
git clone https://github.com/iqtree/iqtree2.git
70+
71+
For IQ-TREE version 1 please clone:
72+
6373
git clone https://github.com/Cibiv/IQ-TREE.git
6474

6575
Please find below separate compilation guide fors [Linux](#compiling-under-linux), [Mac OS X](#compiling-under-mac-os-x), and [Windows](#compiling-under-windows) as well as for [32-bit version](#compiling-32-bit-version) or for [MPI version](#compiling-mpi-version).
@@ -85,26 +95,18 @@ Compiling under Linux
8595

8696
cmake ..
8797

88-
To build the multicore version please add `-DIQTREE_FLAGS=omp` to the cmake command:
89-
90-
cmake -DIQTREE_FLAGS=omp ..
91-
9298
If `cmake` failed with message about `Eigen3 not found`, then install Eigen3 library and run `cmake` again. If this still failed, you have to manually specify the downloaded directory of Eigen3 with:
9399

94100
cmake -DEIGEN3_INCLUDE_DIR=<eigen3_dir> ..
95101

96102

97103
5. Compile source code with `make`:
98104

99-
make
100-
101-
You can speed up the compilation by specifying the number of CPU cores to use with `make` by e.g.:
102-
103-
make -j4
104-
105-
to use 4 cores instead of the default 1 core.
105+
make -j
106+
107+
`j` option tells it to use all CPU cores to speed up the compilation. Without this option, `make` uses only one core, which might be slow.
106108

107-
This creates an executable `iqtree` (`iqtree-omp` for older multicore versions <= 1.5.X). It can be copied to your system search path so that IQ-TREE can be called from the Terminal simply with the command line `iqtree`.
109+
This creates an executable `iqtree2` (`iqtree` for version 1). It can be copied to your system search path so that IQ-TREE can be called from the Terminal simply with the command line `iqtree2`.
108110

109111
>**TIP**: The above guide typically compiles IQ-TREE with `gcc`. If you have Clang installed and want to compile with Clang, the compilation will be similar to Mac OS X like below.
110112
{: .tip}
@@ -118,6 +120,8 @@ Compiling under Mac OS X
118120

119121
* Make sure that Clang compiler is installed, which is typically the case if you installed Xcode and the associated command line tools.
120122

123+
* If you installed cmake with Homebrew
124+
121125
* Find the path to the CMake executable, which is typically `/Applications/CMake.app/Contents/bin/cmake`. For later convenience, please create a symbolic link `cmake` to this cmake executable, so that cmake can be invoked from the Terminal by simply entering `cmake`.
122126

123127
The steps to compile IQ-TREE are similar to Linux (see above), except that you need to specify `clang` as compiler when configuring source code with CMake (step 4):
@@ -280,3 +284,15 @@ Windows binaries were statically compiled under Windows 7 using Clang 3.9.0 in c
280284
cmake -G "MinGW Makefiles" -DIQTREE_FLAGS=static -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_FLAGS=--target=i686-pc-windows-gnu -DCMAKE_CXX_FLAGS=--target=i686-pc-windows-gnu -DCMAKE_MAKE_PROGRAM=mingw32-make ..
281285

282286

287+
288+
Setup an Xcode project in MacOS
289+
-------------------------------
290+
<div class="hline"></div>
291+
292+
Many developers in MacOS use Xcode to develop the code. To generate an XCode project for IQ-TREE, you need to run:
293+
294+
mkdir build-xcode
295+
cd build-xcode
296+
cmake -G Xcode <IQTREE_SOURCE_DIR>
297+
298+
This will generate a a subfolder `build-xcode/iqtree.xcodeproj`, which you can open in Xcode now.

doc/Complex-Models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: userdoc
33
title: "Complex Models"
4-
author: Dominik Schrempf, Jana Trifinopoulos, M Bui, Minh Bui
4+
author: Dominik Schrempf, Jana Trifinopoulos, Minh Bui
55
date: 2019-08-08
66
docid: 11
77
icon: book

doc/Concordance-Factor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: userdoc
33
title: "Concordance Factor"
4-
author: M Bui
4+
author: Minh Bui
55
date: 2021-03-11
66
docid: 6
77
icon: info-circle

doc/Dating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: userdoc
33
title: "Phylogenetic Dating"
4-
author: M Bui, Rob Lanfear
4+
author: Minh Bui, Rob Lanfear
55
date: 2021-03-11
66
docid: 7
77
icon: info-circle

doc/Frequently-Asked-Questions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: userdoc
33
title: "Frequently Asked Questions"
4-
author: Heiko Schmidt, Jana Trifinopoulos, M Bui, Minh Bui
4+
author: Heiko Schmidt, Jana Trifinopoulos, Minh Bui
55
date: 2020-10-28
66
docid: 9
77
icon: question-circle

0 commit comments

Comments
 (0)