fnndsc/pl-dircopy

pl-dircopy

!Docker版本 !许可证 !https://github.com/FNNDSC/pl-dircopy/workflows/ci/badge.svg

目录

• 概述
• 核心功能
• 前置条件
• 使用方法
• 开发指南
• 示例

概述

pl-dircopy是一个ChRIS（***成像研究计算平台）的FS（Feed Synthesis）插件应用，用于将文件/目录数据从输入源复制到输出目标。当从与CUBE通信的客户端调用时，输入目录被解释为Swift存储中的位置，而非本地文件系统位置。

核心功能

• 复制一个或多个对象存储目录的内容到指定输出目录
• 支持通过逗号分隔的字符串指定多个源目录
• 与ChRIS平台集成，适用于Swift存储环境下的数据迁移

前置条件

当从客户端运行此插件连接到CUBE时，输入目录实际存在于Swift存储中，因此输入目录的值是Swift存储中的前缀。有关更多信息，请参考CUBE的wiki页面。

使用方法

基本命令格式

bash
python dircopy.py
    [-h] [--help]
    [--json]
    [--man]
    [--meta]
    [--savejson <DIR>]
    [-v <level>] [--verbosity <level>]
    [--version]
    <outputDir>
    --dir <DIR>

参数说明

• -h, --help: 显示帮助信息并退出
• --json: 显示应用的JSON表示并退出
• --man: 打印此手册页并退出
• --meta: 打印插件元数据并退出
• --savejson <DIR>: 将JSON表示文件保存到指定目录并退出
• -v <level>, --verbosity <level>: 应用的详细程度（当前未使用）
• --version: 打印版本号并退出
• <outputDir>: 输出目录路径（必需）
• --dir <DIR>: 必需参数，逗号分隔的一个或多个源目录列表（字符串）

获取帮助

bash
docker run --rm fnndsc/pl-dircopy dircopy --man

运行容器

需使用-v标志指定输出目录映射：

bash
docker run --rm -u $(id -u) -v $(pwd)/out:/outgoing \
    fnndsc/pl-dircopy dircopy /outgoing --dir <DIR>

开发指南

构建Docker镜像

bash
docker build -t local/pl-dircopy .

运行单元测试

bash
docker run --rm local/pl-dircopy nosetests

示例

以下示例将复制cube/uploads和SERVICES/PACS/BCH目录中的所有文件到输出目录（注：这是仅在ChRIS平台环境下工作的实用工具插件）：

bash
docker run --rm -v $(pwd)/out:/outgoing fnndsc/pl-dircopy \
    dircopy /outgoing --dir 'cube/uploads,SERVICES/PACS/BCH'

!https://raw.githubusercontent.com/FNNDSC/cookiecutter-chrisapp/master/doc/assets/badge/light.png