首页
/ ETE Toolkit 使用与技术文档

ETE Toolkit 使用与技术文档

2024-12-20 11:44:04作者:宣聪麟

1. 安装指南

快速安装

使用以下命令通过pip快速安装ETE:

pip install https://github.com/etetoolkit/ete/archive/ete4.zip

本地开发安装

若要在本地目录安装ETE以方便开发,可以按照以下步骤:

  • 克隆仓库(git clone https://github.com/etetoolkit/ete.git
  • 安装依赖项
    • 如果使用conda,执行:conda install -c conda-forge cython bottle brotli numpy scipy
    • 否则,可以使用 pip install <dependencies> 来安装
  • 从仓库根目录构建并安装ete4:pip install -e .

可选依赖项

如果需要使用treeview模块(依赖于PyQt),可以在pip安装时添加[treeview]

例如,使用pip install -e .[treeview]进行本地可编辑安装。或者pip install -e .[treeview,test,doc]来包含测试和生成文档的模块。

2. 使用说明

要加载文件(my_tree.nw)中的树并开始交互式探索,可以使用ete4工具并运行以下命令:

ete4 explore -t my_tree.nw

或者在Python会话中输入以下代码:

from ete4 import Tree

t = Tree(open('my_tree.nw'))

t.explore()

这将打开一个浏览器窗口,提供了探索树的界面。

3. 项目API使用文档

ETE Toolkit的API文档通过sphinx自动生成,可以从doc目录的内容中获得,并在这里查看。

4. 项目安装方式

ETE Toolkit提供了多种安装方式,以满足不同用户的需求:

  • 通过pip进行快速在线安装。
  • 克隆项目仓库,在本地环境中安装,便于进行自定义开发和测试。
  • 根据需要选择安装附加模块,如treeview

以上是ETE Toolkit的安装指南和使用说明,用户可以根据具体需求选择合适的安装方式,并利用提供的API进行树的自动化操作、分析和可视化。

登录后查看全文
热门项目推荐