pydra-nireports 0.1.1

开发者安装

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

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

从源目录以开发者模式安装存储库，并安装 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.nireports.auto 软件包

$ nipype-auto-conv/generate

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

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

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

键入和样本测试数据

自动生成的测试将尝试根据字段的类型及其对它的任何约束，以合理的默认值提供要测试的任务实例。然而，这些通常需要手动覆盖，在查阅底层工具的文档后。

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

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