📀 LabCAS Downloader

这是一个简单的LabCAS（实验室目录和存档系统）下载器脚本。该脚本允许您从LabCAS安装程序（例如）进行“批量下载”数据：

• 早期检测研究网络（Early Detection Research Network）的LabCAS
• 分子和细胞特征联合体（Consortium for Molecular and Cellular Characterization of Screen-Detected Lesions）的LabCAS
• 或任何其他支持LabCAS API的LabCAS安装程序。

🖥 先决条件

此软件与Python 3.8、3.9或3.10兼容。其他版本可能也兼容，但尚未进行测试。

💿 安装

要安装LabCAS下载器，只需使用Python包安装程序，即pip，例如：

pip install jpl.labcas.downloader

您可能希望在虚拟环境中这样做，以便该软件包不会与系统上的其他Python使用冲突。例如，在典型的Unix（或macOS）系统上，您将运行（其中$是命令行提示符）：

$ python3 -m venv venv
$ cd venv
$ bin/pip install jpl.labcas.downloader

然后使用venv目录中的bin/jpl-labcas-downloader程序。

💁‍♀️ 用法

要使用LabCAS下载器，您需要准备以下信息：

• 您想要下载的数据的集合ID或集合/数据集ID。例如，如果您需要整个自动乳腺密度量化数据，请使用集合ID Automated_Quantitative_Measures_of_Breast_Density_Data。但是，如果您只想从这个集合中获取C0250数据集，请使用Automated_Quantitative_Measures_of_Breast_Density_Data/C02520。根据需要，您可以为嵌套数据集附加更多/。
• 您分配的LabCAS 用户名和验证账户的密码。
• 最后，您想要使用的API端点
  • 对于EDRN，请使用https://edrn-labcas.jpl.nasa.gov/data-access-api/
  • 对于分子和细胞特征化筛查检测病变联盟，请使用https://edrn-labcas.jpl.nasa.gov/data-access-api/

然后，按照以下方式运行jpl-labcas-downloader

jpl-labcas-downloader --username USERNAME --api URL DATA-ID

例如，要使用用户名jane从https://edrn-labcas.jpl.nasa.gov/data-access-api/ API下载Automated_Quantitative_Measures_of_Breast_Density_Data，请运行

jpl-labcas-downloader --username jane --api https://edrn-labcas.jpl.nasa.gov/data-access-api/ Automated_Quantitative_Measures_of_Breast_Density_Data

系统将提示您输入密码，并将文件写入当前目录。

👉 注意：现有的文件将被覆盖。

🎨 自定义

jpl-labcas-downloader支持多种选项以及环境变量以自定义其行为。

• --username USERNAME指定用于通过API进行身份验证的用户名。您可以设置LABCAS_USERNAME环境变量作为默认值。省略此项将不进行身份验证。
• --password PASSWORD表示要使用的密码，但这是不安全的，因为密码不应放在命令行上。LABCAS_PASSWORD可以提供默认密码。但是，如果既未提供选项也未提供环境变量，则系统将提示您输入密码。
• --api URL指定要查询的LabCAS API的URL。它默认为LABCAS_API_URL环境变量。如果两者都没有提供，则https://edrn-labcas.jpl.nasa.gov/data-access-api/是后备值。
• --TARGET DIR指定写入输出文件的目录。它默认为当前目录。

您可以通过运行jpl-labcas-downloader --help来查看所有选项。

👥 贡献

在JPL信息中心，我们重视我们的社区健康，就像我们重视代码一样，这包括参与创建和改进此软件。为此，我们要求您阅读并实践这些文档中描述的内容。

• 我们的贡献者指南说明了我们接受的贡献类型。
• 我们的行为准则概述了我们实践和期望的所有参与我们软件的人的行为标准。

🔧 开发

如果您是这个包的开发者，您可能会做一些像以下这样的操作

$ git clone https://github.com/EDRN/labcas-downloader.git
$ cd labcas-downloader
$ python3 -m venv venv
$ venv/bin/pip install --quiet --upgrade pip setuptools
$ venv/bin/pip install --editable '.[dev]'

然后，您对src目录下的文件所做的更改将在运行时立即反映在venv/bin/jpl-labcas-downloader中。venv/bin还将包含支持开发工具。

🔢 版本控制

我们使用SemVer哲学来为该软件进行版本控制。

📃 许可证

该项目在Apache版本2许可证下授权。