Skip to content

Commit f9fbbf8

Browse files
committed
MAINT: Remove references to IQ-TREE 2 in favour of simply IQ-TREE
1 parent 35eba7d commit f9fbbf8

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

docs/apps/model_finder.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# %% [markdown]
2-
# We use the `piqtree_mfinder` app to rank models. This is the python binding to the IQ-TREE 2 ModelFinder tool.
2+
# We use the `piqtree_mfinder` app to rank models. This is the python binding to the IQ-TREE ModelFinder tool.
33

44
# %%
55
from cogent3 import app_help, get_app, load_aligned_seqs

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
## Overview
44

5-
`piqtree` is a Python package that exposes selected [IQ-TREE 2](http://www.iqtree.org) capabilities within Python, using the [cogent3](https://cogent3.org) library as the interface.
5+
`piqtree` is a Python package that exposes selected [IQ-TREE](http://www.iqtree.org) capabilities within Python, using the [cogent3](https://cogent3.org) library as the interface.
66

77
`piqtree` is implemented with the goals of:
88

9-
- making the individual high-performance components of IQ-TREE 2 available within Python, enabling the community to take advantage of these routines.
9+
- making the individual high-performance components of IQ-TREE available within Python, enabling the community to take advantage of these routines.
1010
- facilitating exploratory analyses by leveraging cogent3's capabilities to provide a rich user experience in interactive Jupyter notebooks, e.g. trivial parallelisation across collections of alignments.
1111
- code using piqtree apps should be easy to understand.
1212

1313
In addition to the functions provided, `piqtree` provides mini-applications in the form of [cogent3 apps](https://cogent3.org/doc/app/index.html). These can interplay with other such apps, e.g. the [cogent3-ete3](https://pypi.org/project/cogent3-ete3/) tree conversion plugin, the [diverse-seqs](https://pypi.org/project/diverse-seq/) sequence subsampling plugin.
1414

1515
> **Note**
16-
> `piqtree` does not implement all of the capabilities of IQ-TREE 2!
16+
> `piqtree` does not implement all of the capabilities of IQ-TREE!
1717
1818
## Installation
1919

src/piqtree/_libiqtree/_piqtree.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ int mine() {
171171
}
172172

173173
PYBIND11_MODULE(_piqtree, m) {
174-
m.doc() = "piqtree - Unlock the Power of IQ-TREE 2 with Python!";
174+
m.doc() = "_piqtree - Linking IQ-TREE to Python!";
175175

176176
m.attr("__iqtree_version__") = version();
177177

src/piqtree/_libiqtree/_piqtree.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,4 @@ extern "C" StringResult build_njtree(StringArray& names,
130130
*/
131131
extern "C" StringResult version();
132132

133-
#endif /* LIBIQTREE2_FUN */
133+
#endif /* _PIQTREE_H */

src/piqtree/iqtree/_jc_distance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ def jc_distances(
4747
aln : c3_types.AlignedSeqsType
4848
alignment to compute pairwise JC distances for.
4949
num_threads: int | None, optional
50-
Number of threads for IQ-TREE 2 to use, by default None (all available threads).
50+
Number of threads for IQ-TREE to use, by default None (all available threads).
5151
5252
Returns
5353
-------

src/piqtree/iqtree/_model_finder.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def model_finder(
140140
rand_seed : int | None, optional
141141
The random seed - 0 or None means no seed, by default None.
142142
num_threads: int | None, optional
143-
Number of threads for IQ-TREE 2 to use, by default None (single-threaded).
143+
Number of threads for IQ-TREE to use, by default None (single-threaded).
144144
If 0 is specified, IQ-TREE attempts to find the optimal number of threads.
145145
146146
Returns

src/piqtree/iqtree/_tree.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ def build_tree(
218218
If 0 is provided, then no bootstrapping is performed.
219219
At least 1000 is required to perform bootstrapping.
220220
num_threads: int | None, optional
221-
Number of threads for IQ-TREE 2 to use, by default None (single-threaded).
221+
Number of threads for IQ-TREE to use, by default None (single-threaded).
222222
If 0 is specified, IQ-TREE attempts to find the optimal number of threads.
223223
224224
Returns
@@ -284,7 +284,7 @@ def fit_tree(
284284
rand_seed : int | None, optional
285285
The random seed - 0 or None means no seed, by default None.
286286
num_threads: int | None, optional
287-
Number of threads for IQ-TREE 2 to use, by default None (single-threaded).
287+
Number of threads for IQ-TREE to use, by default None (single-threaded).
288288
If 0 is specified, IQ-TREE attempts to find the optimal number of threads.
289289
290290
Returns

0 commit comments

Comments
 (0)