wdl

工作流说明语言（WDL）

工作流说明语言（WDL）是用可读和可写的语法描述数据处理工作流的开放标准。 WDL使定义分析任务，在工作流程中将它们连接在一起并并行化其执行变得直接。该语言努力对各种用户（包括程序员，分析师和生产系统运营商）都可以访问和理解。该语言可以简单地表达出常见的模式，例如散布收集和有条件执行。 WDL专为可移植性而设计，并且在包括HPC系统和云平台在内的各种环境中可以选择多种实现。

版本控制

WDL版本控制遵循语义版本惯例。

WDL语言具有两个数字版本（例如， 1.2 ）。次要版本编号（例如1.1至1.2 ）的增加表示语言或标准库功能的添加或非破坏性更改。主要（第一个）版本号（例如1.0至2.0 ）的增加表明已经进行了破坏变化。

WDL规范具有三个数字版本（例如， 1.2.0 ）。规范版本跟踪语言版本，但是还可能有补丁版本（由补丁更改或第三个版本编号表示），其中包括用于错别字的修复程序，其他示例或歧义语言的非破坏性澄清。

语言规格

WDL规范包含所有相关信息，包括用户和开发人员，包括想要实施执行引擎的信息。该GitHub项目将当前版本的分支用作其主要分支，因此，只要您访问该项目的根URL，您将始终看到规范的当前版本。除非绝对必要，否则强烈建议用户使用当前版本的规范。

此分支适用于WDL语言规范的1.2版。应对该分支机构的所有开发新的非破坏功能。

规格的先前版本可以在此处找到：

• 1.1
• 1.0

有许多草稿版本与创建WDL的初步努力相对应。尽管这些是功能规格，但不应将其视为功能完整，并且包含许多错误和不规则性。

• 草稿-3
• 草稿2
• 草稿1

规范的下一个主要版本是2.0。应对该分支机构的所有新破坏功能的开发。

社区和支持

WDL社区取决于您的参与。鼓励您提出问题，帮助其他用户，并在可能的情况下做出贡献。相互作用主要发生在github和松弛上。 WDL社区还拥有一个官方博客，在其中发布了公告。

问一个问题

• 在讨论中进行搜索，以查看是否已经提出了问题；如果不是，请开始新的讨论。
• 加入我们的休闲，并在#support频道中询问。
• 搜索生物信息学堆栈交换以获取先前回答的问题，或提出一个新问题。
• 搜索Google组以获取先前回答的问题。这个小组在很大程度上是不活动的，因此您可以在上面的一个地方之一提出新问题。

错误和新功能

• 搜索现有问题。如果您的问题尚未报告，请创建一个新问题。
• 对于功能reqeusts，您可以在上面列出的以获取社区反馈的地方首先开始讨论。
• 如果您想为问题提供修复/实施，请在提交拉动请求之前阅读有关贡献的信息。

文档

• wdl-docs
• 学习WDL
• WDL资源由Terra（Broad Institute的产品）提供

已发表的工作流程

以下是开源WDL工作流的集合。您需要的WDL任务或工作流可能已经在其中一个存储库中可用，或者您可能会找到类似的工作流程并根据您的需求进行自定义。

• Dockstore
• biowdl
• 广泛的研究所经纱
• GATK工作流程
• 编码
• Terra（需要注册）

软件和工具

执行引擎和平台

WDL没有正式实施。依靠第三方提供可安装的软件或托管平台来解释和执行WDL工作流和任务。尽管WDL尚未具有官方合规计划或认证流程，但实施者有望根据规范设计其工具，以最大程度地提高实施过程中工作流的可移植性。尽管如此，实施者可能会提供其他特定于可选的功能。请参阅与每个工具/平台关联的文档，以获取有关可用执行选项和支持的信息。

执行	需要安装	本地执行	HPC	云
AWS健康组学	不	不	不	AWS
克伦威尔 *	是的	是的	许多	AWS批次，Azure，GCP
DXCOMPILER	是的	不	不	Dnanexus
Miniwdl	是的	是的	sl	AWS批次
Terra	不	不	不	Azure，GCP

*另请参阅WDL Runner，这是一个使用Cromwell在GCP上启动WDL工作流的脚本

语法，解析器和语言支持

• WDL解析器存储库提供各种格式的语法定义，并为各种语言生成解析器。
• MiniWDL为WDL提供Python绑定以及命令行工具，用于验证，覆盖和生成工作流程输入模板。
• Womtool是用于WDL解析，验证，覆盖和图表的独立Java工具。
• WDLTools-提供1）基于Antlr4语法语法的解析器Java/Scala库，用于WDL 2、1.0、1.1、1.1和2.0； 2）用于检查，类型检查，覆盖，代码格式的命令行工具（包括从较旧的WDL版本升级到较新的WDL版本），生成文档以及本地执行WDL任务。
• 链轮适用于WDL文件的软件包管理器和Linter。

IDE支持

IDE	工具
emacs	poly-wdl
emacs	WDL模式
喷气桥	温斯坦利
升华	WDL语法荧光笔
vim	vim-wdl
Visual Studio代码	WDL语法荧光笔

文档

• WDL-AID基于WDL文件中定义的parameter_meta信息生成了WDL工作流的输入的文档。
• wdldoc

测试

• WDL检验是用于WDL实现的测试用例的集合。为编写与自动测试框架兼容的新测试提供了规范。
• PYTEST-WORKFLOW是一种实现 - 敏捷的工作流测试仪。它可以与Cromwell和MiniWDL一起使用。使用PYTEST作为基础测试框架。可以以YAML格式或Python代码指定测试。
• Pytest-WDL是Pytest单元测试框架的插件，可实现WDL任务和工作流程的测试。可以以YAML格式或Python代码指定测试。

包装

• MiniWDL Zip生成一个ZIP文件，包括给定的WDL源代码文件和其导入的任何其他WDL文件。可以将ZIP文件直接提供给MiniWDL运行，该运行可以自动提取。
• WDL Packager将工作流程及其所有导入到ZIP文件中。该ZIP可以用作Cromwell的导入ZIP软件包。该实用程序可以将非WDL文件（例如许可证）添加到ZIP软件包，并提供以二进制可重现方式包装ZIP的选项。

贡献

WDL仅通过社区贡献来进步。虽然参与讨论和提交问题是参与的好方法，但还需要帮助来实施规格的更改。有关如何贡献的更多信息，请阅读《贡献指南》。

RFC过程

提交的拉请请求受RFC流程的约束。如果您想查看提交给规范的更改，请查看并熟悉该过程。

治理

WDL规范完全是由社区驱动的；但是，它是由治理委员会监督的。如果您有兴趣参与WDL治理，请加入Slack并在#general频道中发布消息。