Achelous pipeline 管理工具

随着基因组研究和应用的发展，不同类型测序策略可谓日新月异。随之而来的问题便是流程的丰富性出现井喷式增长。因此，对于大型测序中心而言，对不同类型流程的管理便成为一个亟待解决的问题。Achelous 平台为用户提供了流程管理工具，可以轻松实现流程的发布、修改、删除、版本管理等功能。

Achelous 流程管理相关基本概念

用户: Achelous 对流程的管理是基于用户的，在系统中，不同的用户之间的流程相对封闭。对于某流程而言，其所有者(owner) 是唯一的。只有流程所有者，才有权对流程进行修改或删除。
用户组：与Linux 中组概念类似，同一组内的不同用户之间，可以复制组内其他成员的流程，复制后的流程可以进行修改和删除等操作。
Pipeline-Name：对于特定流程，流程名称是其唯一标识，用户可以通过使用流程名称，进行流程的修改操作。

使用Achelous 添加 Pipeline

生物信息分析人员可以通过以下命令实现分析流程的添加：

biocli pipeline add [选项] <file>

其中：

<file> 为流程信息文件，支持 JSON 和 YAML 格式
-d / --source=SOURCE：需要添加的 wdl 脚本所在目录（注意：-d 所指示的路径应为相对路径）
-y / --yaml：输入文件为 YAML 格式

pipeline.json 文件的基本格式为：

{
    "Name":"Pipeline-Name", 
    "Type" :"WDL",
    "Description" : "Simple pipeline for Bioinformation analysis",
    "wdl" : {
    "WorkflowFile" : "main.wdl"
    }
}

例如：

[demo@Cc1Xtcls]$ biocli pipeline add pipeline.json -d wdl-scripts/

使用Achelous 查看用户名下全部Pipeline

用户可通过以下命令获得系统中存在的pipeline 列表：

biocli pipeline list

使用Achelous 查看Pipeline 详细信息

用户可通过以下命令查看特定流程的详细信息：

biocli pipeline info [选项] <name>

<name>：流程名称
-v / --version="head"：查看指定版本的流程信息，默认为最新版本（head）

例如：

[demo@Cc1Xtcls]$ biocli pipeline info demo_pipeline
[demo@Cc1Xtcls]$ biocli pipeline info demo_pipeline -v v1.0

使用Achelous 查看Pipeline 版本列表

用户可通过以下命令查看流程的所有版本：

biocli pipeline version <name>

<name>：流程名称

例如：

[demo@Cc1Xtcls]$ biocli pipeline version demo_pipeline
Version: v1.0
Version: v1.1
Version: head

使用Achelous 复制其他用户Pipeline

对于不同用户的分析流程，可以通过以下命令实现

biocli pipeline clone <src> <dst>

<src> 为需要被复制的流程名称；
<dst> 为复制后流程的名称

注意：如果用户需要修改某一个不属于自己的流程，需要进行clone 操作

使用Achelous 删除 Pipeline

用户可以通过以下命令，实现删除已经存在的Pipeline

biocli pipeline delete <name>

注意：该操作只对Owner为目前用户的流程起效，非流程Owner无权删除该流程

使用Achelous 更新 Pipeline

对于已经存在的Pipeline 用户可以通过以下命令，对流程进行修改

biocli pipeline update [选项] <file>

其中：

<file> 为记录Pipeline 信息的文件，支持 JSON 和 YAML 格式
-d / --source=SOURCE：存放 wdl 脚本的目录相对路径
-f / --force：当流程正被运行中作业使用时，强制更新
-y / --yaml：输入文件为 YAML 格式
-m / --mainfileonly：仅更新主文件

例如：

[demo@Cc1Xtcls]$ biocli pipeline update pipeline.json -d wdl-scripts/
[demo@Cc1Xtcls]$ biocli pipeline update pipeline.json -d wdl-scripts/ -f

使用Achelous 导出 Pipeline

用户可以通过以下命令将流程导出到文件中：

biocli pipeline dump [选项] <pipeline> <file>

<pipeline>：流程名称
<file>：导出文件路径
-v / --version="head"：导出指定版本的流程，默认为最新版本
-y / --yaml：输出为 YAML 格式

例如：

[demo@Cc1Xtcls]$ biocli pipeline dump demo_pipeline demo_pipeline_backup.json
[demo@Cc1Xtcls]$ biocli pipeline dump demo_pipeline demo_pipeline_v1.json -v v1.0

Achelous 流程管理