pydra-niworkflows 0.1.1

开发者安装

安装与AFNI特定文件格式相对应的 fileformats 软件包

$ pip install -e ./related-packages/fileformats[dev]
$ pip install -e ./related-packages/fileformats-extras[dev]

从源目录安装repo并安装pre-commit以确保代码风格和质量的一致性。

$ pip install -e .[test,dev]
$ pre-commit install

接下来，安装运行自动转换脚本的要求，并从它们的Nipype对应物生成Pydra任务接口

$ pip install -r nipype-auto-conv/requirements.txt

运行转换脚本以将Nipype接口转换为Pydra

$ nipype-auto-conv/generate

方法论

此软件包的开发预计将有两个阶段

1. 其中对应的Nipype接口被认为是基准，Pydra任务从它们生成

2. 当Pydra任务被认为是成熟的，并且手动进行编辑时

不同的任务可能会在不同的时间成熟，因此可能存在1和2之间的中间阶段。

自动转换阶段

自动转换的Pydra任务是从它们相应的Nipype接口生成的，并结合位于 nipype-auto-conv/specs/ 的YAML规范中的“转换提示”。为了帮助自动转换器生成有效的pydra任务，需要手动编辑自文档化的转换规范。编辑一个或多个转换规范后，应通过运行以下命令重新生成 pydra.tasks.niworkflows.auto 软件包

$ nipype-auto-conv/generate

应在自动生成的任务上运行测试，以查看它们是否有效

$ pytest --doctest-modules pydra/tasks/niworkflows/auto/tests/test_<the-name-of-the-task-you-edited>.py

如果测试通过，则应编辑 pydra/tasks/niworkflows/v<tool-version>/__init__.py 文件，导入现在有效的任务接口，以表示它已通过验证并准备使用，例如

键入和样本测试数据

自动生成的测试将尝试使用基于字段类型的合理默认值提供要测试的任务实例。然而，这些值通常需要根据底层工具的文档进行手动覆盖。

对于基于文件的数据，将自动创建用于选定格式类型的文件系统对象，例如Nifti、Dicom。因此，在YAML规范的 inputs > types 和 outputs > types 字典中，使用与 fileformats 类相对应的“mime-like”字符串指定文件格式非常重要。

如果fileformats中未实现所需的文件类型，请参阅 fileformats 文档 了解如何定义新的文件格式类型，并参阅 fileformats-medimage-extras 了解如何为它们实现生成样本数据的方法的示例。