用于提交CFDE数据集的命令行工具
项目描述
CFDE Submit
这是一个与Globus Automate Flows交互的CFDE用例客户端。提供了Python API和CLI工具。
安装
CFDE提交客户端需要Python 3.6或更高版本。要检查您安装的Python版本,运行python –version。如果您同时安装了Python 2和Python 3,您可能需要运行python3 –version进行检查。如果是这种情况,您将需要使用pip3而不是下面的pip。
使用pip安装
pip install cfde-submit
用法
此工具可以将以下内容导入DERIVA
一个要格式化为BDBag的目录
一个预制的BDBag目录
存档文件中的预制BDBag
在所有情况下,数据必须已经是 CFDE TableSchema 格式,否则导入可能会失败。请参见以下说明(文档链接待定)。
命令行
有以下四个命令可用:run、status、login、logout 和 reset。使用方法如下:
cfde-submit run DATA-PATH 将将位于 DATA-PATH 的数据导入 CFDE。您还可以指定以下选项
--output-dir=OUTPUT_DIR 如果 DATA-PATH 是目录,则将数据复制到您指定的位置,该位置必须不存在且不在 DATA-PATH 内。生成的 BDBag 将以输出目录命名。如果未指定,则必要时将在 DATA_PATH 内创建 BDBag。
--delete-dir 在处理完成后触发删除 output-dir。如果您未指定 output-dir,则此选项不起作用。
--ignore-git 将阻止客户端覆盖 output-dir 和 delete-dir 来处理 Git 仓库。
cfde-submit status 将检查流程实例的状态。
cfde-submit login 将启动登录过程。如果您保存了之前的登录令牌,则此命令将验证这些令牌,并且仅在它们过期时才重新验证您。在 run 或 status 之前运行此命令不是必要的,因为这些命令在需要时也会进行验证。
cfde-submit logout 将登出并撤销任何有效的缓存令牌。
cfde-submit reset 将重置您的 cfde-submit 配置。
Python API
一旦实例化,CfdeClient 类具有以下方法
start_deriva_flow(self, data_path, catalog_id=None, output_dir=None, delete_dir=False, **kwargs)
check_status(self, flow_id=None, flow_instance_id=None, raw=False)
logout(self)
参数的使用方式与 CLI 选项相同,并在方法文档字符串中进行了详细说明。
项目详情
下载文件
下载适用于您的平台文件。如果您不确定选择哪一个,请了解有关 安装包 的更多信息。
源分发
构建分发
cfde-submit-0.2.5.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | fe3b0e28cba40e2b5c95a41cc79701aca4bf4ad411d4178d98d63a09fa250b9f |
|
MD5 | ca1e8f13c39b4bbf3187da674c536af2 |
|
BLAKE2b-256 | afd81dca8ecec99211d3ae3995064f6bf39a9535ba8ee194a7e952edd10809e0 |
cfde_submit-0.2.5-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 19a9bc548679a4628f0b671e015ce8f9820585badedff99405d2a66359a14b37 |
|
MD5 | bc7490e7658a6945158d69cdd81376be |
|
BLAKE2b-256 | d8fec31caf1fe4af7555c5ee4207423e34e7d93f0cb23bdf760868d1abe1b2fa |